Simulation Manager#
The SimulationManager is the central class in EmbodiChain’s simulation framework for managing the simulation lifecycle. It handles:
Asset Management: Loading and managing robots, rigid objects, soft objects, articulations, and lights.
Simulation Loop: Controlling the physics stepping and rendering updates.
Rendering: Managing the simulation window, camera rendering, material settings and ray-tracing configuration.
Interaction: Providing gizmo controls for interactive manipulation of objects.
Configuration#
The simulation is configured using the SimulationManagerCfg class.
from embodichain.lab.sim import SimulationManagerCfg
from embodichain.lab.sim.cfg import DefaultPhysicsCfg
sim_config = SimulationManagerCfg(
width=1920, # Window width
height=1080, # Window height
num_envs=10, # Number of parallel environments
device="cpu", # Simulation device ("cpu" or "cuda:0", etc.)
physics_cfg=DefaultPhysicsCfg(
physics_dt=0.01, # Physics time step
),
arena_space=5.0 # Spacing between environments
)
Configuration Parameters#
Parameter |
Type |
Default |
Description |
|---|---|---|---|
|
|
|
The width of the simulation window. |
|
|
|
The height of the simulation window. |
|
|
|
Whether to run the simulation in headless mode (no Window). |
|
|
|
Optional DexSim scene-node allocation capacity; |
|
|
|
The rendering configuration parameters. |
|
|
|
Rendering GPU index; also resolves an unindexed CUDA compute device. |
|
|
|
The threading mode for the simulation engine. |
|
|
|
The number of CPU threads to use for the simulation engine. |
|
|
|
The number of parallel environments (arenas) to simulate. |
|
|
|
The distance between each arena when building multiple arenas. |
|
|
|
Optional explicit compute-device override. When omitted, the selected physics config keeps its backend default. |
|
|
|
Physics backend configuration (class selects default vs Newton). |
|
|
|
Optional hierarchical wall-time profiler for simulation updates. |
|
|
|
Browser visualization, opt-in Gizmo commands, and Viser server settings. |
Large articulated batches can set scene_node_capacity: 262144 in the training
configuration, or pass scene_node_capacity=262144 to SimulationManagerCfg.
The value reaches WorldConfig.scene_node_capacity and leaves physics parameters
unchanged.
Material reuse#
Set DefaultPhysicsCfg(cache_material=True) to reuse identical physics materials
across objects and environment clones. Training configuration uses
physics: default and physics_config: {cache_material: true}. The default is
False, preserving the existing allocation behavior.
Physics#
Physics backend selection, capability comparisons, shared device settings, and time stepping are covered in Physics. See Default Physics Backend and Newton Physics Backend for backend-specific settings.
Rendering#
Rendering configuration and advanced renderer features live in the dedicated Rendering section. Start with Rendering Configuration for renderer selection and common image-quality settings, then see NVIDIA DLSS for DLSS behavior, quality modes, frame timing, and availability/fallback notes.
Initialization#
Initialize the manager with the configuration object:
from embodichain.lab.sim import SimulationManager, SimulationManagerCfg
# User can customize the config as needed.
sim_config = SimulationManagerCfg()
sim = SimulationManager(sim_config)
Declare, prepare, then step#
Use the same readiness boundary with both physics backends:
Construct the manager and declare the initial assets and sensors.
Register any Newton trajectory or contact-material schedules.
Call
sim.prepare()before reading asset state, joint/link metadata, or native handles.Apply controls and advance time with
sim.update(step=1).Release resources when the simulation finishes.
Newton defers physical model construction until preparation; Default may
materialize assets earlier, but its CUDA buffers also require preparation.
prepare() is idempotent for an unchanged scene and binds declared facades in
place. It publishes initial render state without advancing simulation time.
Declare all deformables before the first preparation. After supported topology
changes, prepare again before consuming state and reacquire native views.
The compatibility methods init_gpu_physics() and
finalize_newton_physics() delegate to prepare(); new examples should use
the shared method. See Default Physics Backend for a complete minimal loop and
Newton Physics Backend for the matching backend configuration.
Profiling simulation updates#
Configure ProfilerCfg directly on the simulation manager when using
the simulation without a Gym environment:
from embodichain.lab.sim import ProfilerCfg, SimulationManager, SimulationManagerCfg
sim = SimulationManager(
SimulationManagerCfg(
profiler=ProfilerCfg(enable_time=True, warmup_steps=0),
)
)
sim.update(step=4)
sim.profiler.report()
Each standalone SimulationManager.update() call creates a sim_update
root. The physics_steps section contains one gizmo_update and one
world_update sample per physics substep, plus optional
window_record_capture and visualization_capture samples when those features
are enabled. Consequently, world_update.calls is the total number of physics
substeps, its mean is the mean cost of one substep, and its total is the
aggregate physics-update time.
When a Gym environment owns the manager, it reuses the same profiler instance.
Simulation sections compose below step.sim_update without adding another
sim_update path component, so existing environment reports remain compatible.
Browser visualization#
SimulationManager owns the optional Viser runtime. Configure it through
SimulationManagerCfg.visualization:
from embodichain.lab.sim import SimulationManager, SimulationManagerCfg
from embodichain.lab.visualization import VisualizationCfg
sim = SimulationManager(
SimulationManagerCfg(
headless=True,
visualization=VisualizationCfg(
backend="viser",
env_ids=[0],
),
)
)
print(sim.visualization_health.endpoint)
When backend="viser", the manager starts the server during construction.
Assets added or removed later are published automatically on the next
SimulationManager.update(). The runtime is stopped by
SimulationManager.destroy(), or explicitly with
SimulationManager.stop_visualization().
The browser supports rigid objects and groups, robot and articulation links, cloth, soft bodies, camera frustums, low-frequency RGB preview, overlays, and a 1 m ground grid. For configuration, performance behavior, deformable-object limitations, remote access, and troubleshooting, see Browser visualization with Viser.
Native point-cloud visualization#
Use SimulationManager.visualize_point_cloud() to add static point-based
debug or analysis data to the native DexSim viewer. It accepts NumPy arrays or
Torch tensors with point positions shaped (N, 3), plus optional per-point RGB
or RGBA colors. Colors can be normalized floats or uint8 values in [0, 255];
the manager converts them to renderer-ready RGB values. Omitting colors
renders the point cloud in green.
import numpy as np
points = np.array([[0.0, 0.0, 0.2], [0.1, 0.0, 0.2]], dtype=np.float32)
colors = np.array([[255, 0, 0], [0, 255, 0]], dtype=np.uint8)
point_cloud = sim.visualize_point_cloud(
points,
colors=colors,
point_size=6.0,
name="debug_points",
)
The returned native point-cloud handle can be queried or modified with the DexSim point-cloud API. This method targets the native window; use the browser-overlay APIs documented in Browser visualization with Viser for Viser. See Visualizing a Point Cloud for a runnable color-and-position verification example.
Assets Management#
The manager provides methods to add, retrieve and remove various simulation assets including:
Rigid Objects
Soft Objects
Articulations
Robots
Lights
Materials
For more details on simulation assets, please refer to their respective documentation pages.
USD Import and Export#
Importing USD Files#
EmbodiChain supports importing USD files (.usd, .usda, .usdc) for both rigid objects and articulations. When importing USD files, you can choose whether to use the physical properties defined in the USD file or override them with configuration values:
# Import rigid object with USD properties
rigid_cfg = RigidObjectCfg(
shape=MeshCfg(fpath=get_data_path("path/to/object.usd")),
asset_physics_mode="preserve",
)
obj = sim.add_rigid_object(cfg=rigid_cfg)
# Import articulation with USD properties
robot_cfg = ArticulationCfg(
fpath=get_data_path("path/to/robot.usd"),
asset_physics_mode="preserve",
)
robot = sim.add_articulation(cfg=robot_cfg)
Exporting to USD#
You can export the current simulation scene to a USD file using the export_usd() method:
# Export the entire scene to USD
sim.export_usd("my_scene.usda")
This exports all objects, articulations, robots, and their current states to a USD file, which can be:
Reimported into EmbodiChain with preserved properties
Opened in USD-compatible tools (e.g., USD Viewer, Omniverse)
Used as assets for other simulations
See scripts/tutorials/sim/export_usd.py for a complete example.
Simulation Loop#
Physics advances only through explicit update() calls.
Each call applies pending Gizmo controls before every physics step, then updates
simulation time, recording, and browser visualization. Gym environments own this
sequence through env.step(action).
Interactive applications can pace the same fixed-step loop against wall time:
import time
while True:
step_start = time.perf_counter()
sim.update(step=1)
# Read sensors or process application state here.
time.sleep(max(0.0, sim.sim_config.physics_dt - (time.perf_counter() - step_start)))
Wall-clock pacing limits playback speed without changing the configured physics
timestep. Waiting at a REPL or breakpoint pauses physics. Drawing markers and
calling capture_visualization(force=True) publish visual changes without
advancing physics.
Pure IK/FK queries do not require a physics loop.
Mainly used methods#
SimulationManager.update(physics_dt=None, step=10): Steps the physics simulation with optional custom time step and number of steps. Ifphysics_dtis None, uses the configured physics time step.SimulationManager.enable_physics(enable: bool): Enable or disable physics simulation.SimulationManager.start_visualization(): Start or return the configured visualization runtime.SimulationManager.refresh_visualization(): Immediately republish scene topology.SimulationManager.capture_visualization(force=False): Capture the current scene state.SimulationManager.capture_visualization_safely(force=False): Capture without allowing a visualization failure to interrupt simulation progress.SimulationManager.stop_visualization(): Stop Viser and release its server port.SimulationManager.visualize_point_cloud(points, colors=None, point_size=2.0, name="point_cloud"): Add a static colored point cloud to the native DexSim viewer.SimulationManager.visualization_health: Return endpoint, client count, revision, and worker status.SimulationManager.visualization_stats: Return capture, queue, payload, and upload telemetry.
Multiple instances#
SimulationManager supports multiple instances to run separate simulations world independently. Each instance maintains its own simulation state, assets, and configurations.
To get current instance number of
SimulationManager:SimulationManager.get_instance_num()To get specific instance:
SimulationManager.get_instance(instance_id).
Currently, multiple instances are not supported for ray tracing rendering backend. Good news is that we are working on adding this feature in future releases.
For more methods and details, see the SimulationManager API.