End to End Guides

End to end workflow guides which cover the entire process of creating USD assets with various capabilities.

• Getting Started
  • Introduction
  • Core specification concepts
  • Should I care about SimReady?
  • Terminology & Concepts
• SimReady Validation Workflow
  • Prerequisites
  • 1. Create a clean virtual environment
  • 2. Install dependencies
  • 3. Run validation on a sample asset
  • 4. Save results to JSON
  • 5. Stamp validation results into the asset
  • 6. Understanding the validator (sample project)
  • Troubleshooting
• SimReady Acceptance Workflow
  • Purpose
  • Goals
  • Process overview
  • Phase 1 — Definition & Alignment
  • Phase 2 — Development & Iteration
  • Phase 3 — Package Deliveries
  • What to expect as a consumer
• Features
  • About this guide
  • What is a Feature?
  • Creating a New Feature
  • Feature Dependencies
  • Feature Documentation Best Practices
  • Testing Your Feature
  • Common Pitfalls
  • Getting Help
  • Summary
• Feature Adapters
  • About this guide
  • What is a Feature Adapter?
  • Feature Adapter Structure
  • Creating a New Feature Adapter
  • Advanced Feature Adapter Patterns
  • Common Use Cases
  • Best Practices
  • Troubleshooting
  • Getting Help
• Profiles
  • About this guide
  • What is a Profile?
  • Profile Examples
  • Creating a New Profile
  • Creating a New Profile Version
  • Creating a Second Profile and Required Adapters
  • Best Practices
  • Getting Help
  • Conclusion
• Runtime Testing
  • Overview and CLI
  • Authoring and Execution Deep Dive
  • Runner Configuration (runners_info.toml)
  • CI/CD Usage (multi-machine, direct CLI)
• SimReady Learning Workflow
  • Core concepts
  • Run the demo validator
  • Where is SAMP.001 defined?
  • What the sample does (SAMP.001 only)
  • When you extend: what we want SAMP.002 to do
  • 1. Define a New Requirement (Markdown)
  • 2. Implement the Rule (Python)
  • 3. Add the new requirement to the existing feature (JSON)
  • 4. Load Order and Running
  • Checklist for extending (stay on SAMP.001 / Feat_1)
  • Tips
  • Appendix: Adding a rule to a new feature
  • Appendix: Capability (category)
  • Appendix: Profile metadata in production assets
• Naming Conventions
  • Purpose
  • What is a well-formed vendor prefix?
  • Rules
  • Example: from unstructured to well-formed
  • Naming across tiers and packages
  • Capabilities folder layout
  • Relationship to existing requirements
  • Appendix A: background and motivation
  • Appendix B: coverage of the original naming-conventions checklist