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.

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 the general/simulation/scene/task/extension blocks, validation rules, and dependencies.\n- Concepts: learn the responsibility boundaries of stereotypes, UniSim, SceneManager, ControllerManager, and ExtensionManager.\n- Examples: adapt fastsim/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, and extension blocks are loaded and validated.

Next steps

Page-to-source mapping (index)

PageWhat it coversImplementation entry points (fastsim)
/documents/library-api/python-sdkPython SDK minimal usage, lifecycle, config loadfastsim/app.py, fastsim/configs/config_manager.py
/documents/configuration/globalgeneral.scan_project, general.root_paths, asset path resolutionfastsim/configs/general_cfg.py, fastsim/utils/asset.py
/documents/configuration/simulationsimulation.stereotype/dt/intiailize_steps and backend-specific fieldsfastsim/configs/simulation_cfg.py, fastsim/simulators/isaaclab/isaaclab_config.py
/documents/configuration/scenescene structure and entity dictionariesfastsim/configs/scene_cfg.py, fastsim/unisim/**
/documents/configuration/tasktask semantics, actions/goals validationfastsim/task/task.py, fastsim/extensions/common/action/action.py, fastsim/extensions/common/goal/goal.py
/documents/configuration/extensionextensions, dependencies, record/replay/server/benchmarkfastsim/extensions/extension_manager.py, fastsim/extensions/**
/documents/concepts/unisimUniSim abstraction and backend adaptersfastsim/unisim/unisim.py, fastsim/simulators/isaaclab/isaaclab_app.py
/documents/concepts/sceneSceneManager lifecycle and spawnablesfastsim/unisim/scene_manager.py, fastsim/unisim/spawnable.py
/documents/concepts/controllercommand queue, Result, controller APIsfastsim/controllers/**
/documents/concepts/extensionextension enable order, record -> artifacts -> replayfastsim/extensions/record/**, fastsim/extensions/replay/**
/documents/examples/*runnable demos and adaptation guidancefastsim/demo/**