Core overview
This page provides the recommended reading path and a source-code mapping index, so you can locate implementations and troubleshoot efficiently while reading the docs.
Recommended reading path
Read in the following order to keep concepts, configuration, and runnable examples aligned:
- QuickStart: validate the FastSim lifecycle and a minimal
step()loop.\n- Configuration: understand thegeneral/simulation/scene/task/extensionblocks, validation rules, and dependencies.\n- Concepts: learn the responsibility boundaries of stereotypes, UniSim, SceneManager, ControllerManager, and ExtensionManager.\n- Examples: adaptfastsim/demo/**to your assets and parameters, then freeze them into reproducible configs.
What you will learn
- Stereotypes & entities: typed descriptions for objects and components in a scene.
- UniSim: unified simulation API and how backend adapters (e.g. Isaac Lab) plug in.
- Config-driven workflows: how
general,simulation,scene,task, andextensionblocks are loaded and validated.
Next steps
- Read the Concepts pages (intro, UniSim, Scene, Controller, Extension).
- For concrete parameters, go to Configuration and QuickStart.
Page-to-source mapping (index)
| Page | What it covers | Implementation entry points (fastsim) |
|---|---|---|
/documents/library-api/python-sdk | Python SDK minimal usage, lifecycle, config load | fastsim/app.py, fastsim/configs/config_manager.py |
/documents/configuration/global | general.scan_project, general.root_paths, asset path resolution | fastsim/configs/general_cfg.py, fastsim/utils/asset.py |
/documents/configuration/simulation | simulation.stereotype/dt/intiailize_steps and backend-specific fields | fastsim/configs/simulation_cfg.py, fastsim/simulators/isaaclab/isaaclab_config.py |
/documents/configuration/scene | scene structure and entity dictionaries | fastsim/configs/scene_cfg.py, fastsim/unisim/** |
/documents/configuration/task | task semantics, actions/goals validation | fastsim/task/task.py, fastsim/extensions/common/action/action.py, fastsim/extensions/common/goal/goal.py |
/documents/configuration/extension | extensions, dependencies, record/replay/server/benchmark | fastsim/extensions/extension_manager.py, fastsim/extensions/** |
/documents/concepts/unisim | UniSim abstraction and backend adapters | fastsim/unisim/unisim.py, fastsim/simulators/isaaclab/isaaclab_app.py |
/documents/concepts/scene | SceneManager lifecycle and spawnables | fastsim/unisim/scene_manager.py, fastsim/unisim/spawnable.py |
/documents/concepts/controller | command queue, Result, controller APIs | fastsim/controllers/** |
/documents/concepts/extension | extension enable order, record -> artifacts -> replay | fastsim/extensions/record/**, fastsim/extensions/replay/** |
/documents/examples/* | runnable demos and adaptation guidance | fastsim/demo/** |