SimReady Foundation - Content Guidelines and Requirements#

Overview#

This documentation is a collection of guidelines and requirements for OpenUSD content. It provides a framework to author OpenUSD content that is suitable for use cases such as rendering, simulation, robotics, and AI training.

Key Concepts#

Requirements#

Requirements are the core building blocks of this documentation. They are specific, testable rules that assets should follow, such as “upAxis shall be Z” or “meshes shall have normals”. Each requirement is assigned a unique ID (for example: VG.027, UN.006, HI.001).

Capabilities#

Capabilities are categories that organize related requirements. Examples include Visualization/Geometry, Core/Units, and Hierarchy. This modular design allows you to implement only the capabilities needed for your particular use case.

Features#

Features are collections of requirements tailored for specific use cases or software features. For example, the “Minimal Placeable Visual” feature references all requirements needed for an asset to be visualized and placed in a scene.

Profiles#

Profiles are predefined bundles of features designed for common scenarios. Examples include the Prop Robotics Neutral profile. Profiles make it easy to test and validate complete asset workflows.

Getting Started#

  • New to SimReady? Start with the Getting Started guide for an introduction and decision tree.

  • Creating Assets? Refer to the Guides to learn how to implement capabilities in your assets.

  • Looking for specific requirements? Browse the Capabilities section for detailed technical specifications.

  • Implementing specific features? Check out the Features section for detailed feature implementations and requirements.

  • Building for a specific use case? Check out the Profiles section to find predefined capability sets.

  • Comparing profiles? See the Profile Comparison table for feature-level differences.

  • Need to reference something? Use the Indexes for quick access to all documentation content.