FastSim documentation
Start with the platform mental model, then progress through configuration compilation, application lifecycle, plugin capabilities, control, and data workflows before switching to source-generated references.
What are you trying to accomplish?
The documentation is not one long tutorial. Choose the route closest to your current job; each path identifies prerequisites, completion criteria, and next steps.
New to FastSim
Build a complete mental model of Core, official plugins, UniRoboSim, and Providers
→02Ready to install and run
Generate a Conda workflow from OS, simulation Provider, and capability choices
→03Designing an application
Move from Runs, components, and lifecycle into Python, Server, and data workflows
→04Developing a plugin
Understand manifests, capability grants, service binding, and independent releases
→05Diagnosing a problem
Narrow failures across compilation, lifecycle, services, Providers, and outputs
→06Looking up an exact interface
Look up configuration fields, Python signatures, REST endpoints, and CLI behavior
→See how one Run moves through the platform
Declarations are first compiled into an immutable plan. The Application then composes Core services, official plugins, and a backend Provider; runtime data returns through stable services or controlled outputs.
Four levels without mixing concepts and interfaces
- 1Orient
Understand FastSim responsibilities and which semantics belong to Core, plugins, and Providers.
- 2Understand
Learn compilation, resolution, lifecycle, generations, capability grants, and Operations.
- 3Apply
Use how-to guides for configuration, components, Python, Server, data, and debugging goals.
- 4Verify
Use source-generated configuration, SDK, REST, and CLI references for exact fields and signatures.
Start here
Establish boundaries, vocabulary, and reading order.
Core concepts
Understand pre-run compilation, runtime state, and cross-plugin collaboration.
User guides
Complete configuration, integration, runtime, service, and debugging goals.
Reference
Fields, signatures, and endpoints generated from current source.
Resources
Runnable cases, official plugin documentation, and release changes.