← Configuration / run
YAMLfastsim/2
Run
FastSim Run fields extracted directly from current configuration source.
Source src/fastsim/config/compiler.pyTop Level Fields · 8Runtime Required Fields · 6Runtime Optional Fields · 2Physics Activation Fields · 4Scene Fields · 8Instance Fields · 9Control Fields · 2Plugin Fields · 5Lock Fields · 6Plan Fields · 13Scenario Plan Fields · 6Scenario Source Inline Fields · 2Scenario Source Component Fields · 6Plan Component Fields · 12Plan Resource Fields · 5Plan Resource Optional Fields · 1Plan Entity Fields · 12Plan Environment Optional Fields · 1Lock Resource Location Fields · 7Plugin Plan Required Fields · 7Plugin Plan Optional Fields · 1Plugin Component Fields · 4Config Component Lock Fields · 13Plugin Configuration Lock Fields · 3Articulation Drive Fields · 3Base Component Origin Fields · 5Plugin Policy Fields · 8Explicit Override Fields · 5Plugin Artifact Record Fields · 6Component Provenance Fields · 4
Top Level Fields 8
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| backend | field | source-defined | — | Name of the UniRoboSim Provider available in the project environment. |
| control | field | source-defined | — | Validated `control` configuration field; constraints follow the current source. |
| name | field | source-defined | — | Stable name used within the current declaration scope. |
| overrides | field | source-defined | — | Validated `overrides` configuration field; constraints follow the current source. |
| plugins | field | source-defined | — | Installed plugins explicitly enabled for this Run. |
| runtime | field | source-defined | — | Lifecycle, frequency, random seed and launch policy. |
| scenario | field | source-defined | — | Reproducible declaration for scene, behavior and evaluation. |
| schema | field | source-defined | — | Configuration contract identifier; current Run files use fastsim/2. |
Runtime Required Fields 6
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| control_hz | field | source-defined | — | Validated `control_hz` configuration field; constraints follow the current source. |
| launch_profile | field | source-defined | — | Validated `launch_profile` configuration field; constraints follow the current source. |
| physics_hz | field | source-defined | — | Validated `physics_hz` configuration field; constraints follow the current source. |
| rate_policy | field | source-defined | — | Validated `rate_policy` configuration field; constraints follow the current source. |
| seed | field | source-defined | — | Validated `seed` configuration field; constraints follow the current source. |
| sensor_hz | field | source-defined | — | Validated `sensor_hz` configuration field; constraints follow the current source. |
Runtime Optional Fields 2
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| physics_activation | field | source-defined | — | Validated `physics_activation` configuration field; constraints follow the current source. |
| physics_profile | field | source-defined | — | Validated `physics_profile` configuration field; constraints follow the current source. |
Physics Activation Fields 4
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| hysteresis_m | field | source-defined | — | Validated `hysteresis_m` configuration field; constraints follow the current source. |
| mode | field | source-defined | — | Validated `mode` configuration field; constraints follow the current source. |
| radius_m | field | source-defined | — | Validated `radius_m` configuration field; constraints follow the current source. |
| update_hz | field | source-defined | — | Validated `update_hz` configuration field; constraints follow the current source. |
Scene Fields 8
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| articulations | field | source-defined | — | Validated `articulations` configuration field; constraints follow the current source. |
| deformables | field | source-defined | — | Validated `deformables` configuration field; constraints follow the current source. |
| environment | field | source-defined | — | Validated `environment` configuration field; constraints follow the current source. |
| fluids | field | source-defined | — | Validated `fluids` configuration field; constraints follow the current source. |
| lights | field | source-defined | — | Validated `lights` configuration field; constraints follow the current source. |
| objects | field | source-defined | — | Validated `objects` configuration field; constraints follow the current source. |
| robots | field | source-defined | — | Validated `robots` configuration field; constraints follow the current source. |
| sensors | field | source-defined | — | Validated `sensors` configuration field; constraints follow the current source. |
Instance Fields 9
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| asset | field | source-defined | — | Validated `asset` configuration field; constraints follow the current source. |
| enabled | field | source-defined | — | Validated `enabled` configuration field; constraints follow the current source. |
| initial_state | field | source-defined | — | Validated `initial_state` configuration field; constraints follow the current source. |
| mount | field | source-defined | — | Validated `mount` configuration field; constraints follow the current source. |
| params | field | source-defined | — | Validated `params` configuration field; constraints follow the current source. |
| pose | field | source-defined | — | Validated `pose` configuration field; constraints follow the current source. |
| scale | field | source-defined | — | Validated `scale` configuration field; constraints follow the current source. |
| static | field | source-defined | — | Validated `static` configuration field; constraints follow the current source. |
| use | field | source-defined | — | Validated `use` configuration field; constraints follow the current source. |
Control Fields 2
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| default_robot | field | source-defined | — | Validated `default_robot` configuration field; constraints follow the current source. |
| precedence | field | source-defined | — | Validated `precedence` configuration field; constraints follow the current source. |
Plugin Fields 5
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| access | field | source-defined | — | Validated `access` configuration field; constraints follow the current source. |
| bindings | field | source-defined | — | Validated `bindings` configuration field; constraints follow the current source. |
| config | field | source-defined | — | Validated `config` configuration field; constraints follow the current source. |
| session | field | source-defined | — | Validated `session` configuration field; constraints follow the current source. |
| use | field | source-defined | — | Validated `use` configuration field; constraints follow the current source. |
Lock Fields 6
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| compiler | field | source-defined | — | Validated `compiler` configuration field; constraints follow the current source. |
| lock_digest | field | source-defined | — | Validated `lock_digest` configuration field; constraints follow the current source. |
| plan | field | source-defined | — | Validated `plan` configuration field; constraints follow the current source. |
| resource_locations | field | source-defined | — | Validated `resource_locations` configuration field; constraints follow the current source. |
| schema | field | source-defined | — | Configuration contract identifier; current Run files use fastsim/2. |
| source | field | source-defined | — | Validated `source` configuration field; constraints follow the current source. |
Plan Fields 13
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| authoring_sha256 | field | source-defined | — | Validated `authoring_sha256` configuration field; constraints follow the current source. |
| backend | field | source-defined | — | Name of the UniRoboSim Provider available in the project environment. |
| components | field | source-defined | — | Validated `components` configuration field; constraints follow the current source. |
| control | field | source-defined | — | Validated `control` configuration field; constraints follow the current source. |
| digest | field | source-defined | — | Validated `digest` configuration field; constraints follow the current source. |
| effective_sha256 | field | source-defined | — | Validated `effective_sha256` configuration field; constraints follow the current source. |
| entities | field | source-defined | — | Validated `entities` configuration field; constraints follow the current source. |
| name | field | source-defined | — | Stable name used within the current declaration scope. |
| plugins | field | source-defined | — | Installed plugins explicitly enabled for this Run. |
| provenance | field | source-defined | — | Validated `provenance` configuration field; constraints follow the current source. |
| runtime | field | source-defined | — | Lifecycle, frequency, random seed and launch policy. |
| scenario | field | source-defined | — | Reproducible declaration for scene, behavior and evaluation. |
| schema | field | source-defined | — | Configuration contract identifier; current Run files use fastsim/2. |
Scenario Plan Fields 6
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| behavior | field | source-defined | — | Validated `behavior` configuration field; constraints follow the current source. |
| digest | field | source-defined | — | Validated `digest` configuration field; constraints follow the current source. |
| evaluation | field | source-defined | — | Validated `evaluation` configuration field; constraints follow the current source. |
| scene | field | source-defined | — | Validated `scene` configuration field; constraints follow the current source. |
| schema | field | source-defined | — | Configuration contract identifier; current Run files use fastsim/2. |
| source | field | source-defined | — | Validated `source` configuration field; constraints follow the current source. |
Scenario Source Inline Fields 2
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| authoring_path | field | source-defined | — | Validated `authoring_path` configuration field; constraints follow the current source. |
| kind | field | source-defined | — | Validated `kind` configuration field; constraints follow the current source. |
Scenario Source Component Fields 6
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| identity | field | source-defined | — | Validated `identity` configuration field; constraints follow the current source. |
| kind | field | source-defined | — | Validated `kind` configuration field; constraints follow the current source. |
| manifest_sha256 | field | source-defined | — | Validated `manifest_sha256` configuration field; constraints follow the current source. |
| requested | field | source-defined | — | Validated `requested` configuration field; constraints follow the current source. |
| variant | field | source-defined | — | Validated `variant` configuration field; constraints follow the current source. |
| version | field | source-defined | — | Validated `version` configuration field; constraints follow the current source. |
Plan Component Fields 12
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| capabilities | field | source-defined | — | Validated `capabilities` configuration field; constraints follow the current source. |
| config_schema | field | source-defined | — | Validated `config_schema` configuration field; constraints follow the current source. |
| defaults | field | source-defined | — | Validated `defaults` configuration field; constraints follow the current source. |
| identity | field | source-defined | — | Validated `identity` configuration field; constraints follow the current source. |
| kind | field | source-defined | — | Validated `kind` configuration field; constraints follow the current source. |
| manifest_sha256 | field | source-defined | — | Validated `manifest_sha256` configuration field; constraints follow the current source. |
| requested | field | source-defined | — | Validated `requested` configuration field; constraints follow the current source. |
| requires | field | source-defined | — | Validated `requires` configuration field; constraints follow the current source. |
| resources | field | source-defined | — | Validated `resources` configuration field; constraints follow the current source. |
| semantics | field | source-defined | — | Validated `semantics` configuration field; constraints follow the current source. |
| variant | field | source-defined | — | Validated `variant` configuration field; constraints follow the current source. |
| version | field | source-defined | — | Validated `version` configuration field; constraints follow the current source. |
Plan Resource Fields 5
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| format | field | source-defined | — | Validated `format` configuration field; constraints follow the current source. |
| name | field | source-defined | — | Stable name used within the current declaration scope. |
| requested_uri | field | source-defined | — | Validated `requested_uri` configuration field; constraints follow the current source. |
| role | field | source-defined | — | Validated `role` configuration field; constraints follow the current source. |
| sha256 | field | source-defined | — | Validated `sha256` configuration field; constraints follow the current source. |
Plan Resource Optional Fields 1
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| dependencies | field | source-defined | — | Validated `dependencies` configuration field; constraints follow the current source. |
Plan Entity Fields 12
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| capabilities | field | source-defined | — | Validated `capabilities` configuration field; constraints follow the current source. |
| component | field | source-defined | — | Validated `component` configuration field; constraints follow the current source. |
| enabled | field | source-defined | — | Validated `enabled` configuration field; constraints follow the current source. |
| id | field | source-defined | — | Validated `id` configuration field; constraints follow the current source. |
| initial_state | field | source-defined | — | Validated `initial_state` configuration field; constraints follow the current source. |
| kind | field | source-defined | — | Validated `kind` configuration field; constraints follow the current source. |
| mount | field | source-defined | — | Validated `mount` configuration field; constraints follow the current source. |
| params | field | source-defined | — | Validated `params` configuration field; constraints follow the current source. |
| pose | field | source-defined | — | Validated `pose` configuration field; constraints follow the current source. |
| resources | field | source-defined | — | Validated `resources` configuration field; constraints follow the current source. |
| scale | field | source-defined | — | Validated `scale` configuration field; constraints follow the current source. |
| semantics | field | source-defined | — | Validated `semantics` configuration field; constraints follow the current source. |
Plan Environment Optional Fields 1
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| static | field | source-defined | — | Validated `static` configuration field; constraints follow the current source. |
Lock Resource Location Fields 7
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| component | field | source-defined | — | Validated `component` configuration field; constraints follow the current source. |
| local_path | field | source-defined | — | Validated `local_path` configuration field; constraints follow the current source. |
| name | field | source-defined | — | Stable name used within the current declaration scope. |
| resolved_uri | field | source-defined | — | Validated `resolved_uri` configuration field; constraints follow the current source. |
| sha256 | field | source-defined | — | Validated `sha256` configuration field; constraints follow the current source. |
| variant | field | source-defined | — | Validated `variant` configuration field; constraints follow the current source. |
| version | field | source-defined | — | Validated `version` configuration field; constraints follow the current source. |
Plugin Plan Required Fields 7
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| access | field | source-defined | — | Validated `access` configuration field; constraints follow the current source. |
| bindings | field | source-defined | — | Validated `bindings` configuration field; constraints follow the current source. |
| component | field | source-defined | — | Validated `component` configuration field; constraints follow the current source. |
| config | field | source-defined | — | Validated `config` configuration field; constraints follow the current source. |
| requirements | field | source-defined | — | Validated `requirements` configuration field; constraints follow the current source. |
| role | field | source-defined | — | Validated `role` configuration field; constraints follow the current source. |
| session | field | source-defined | — | Validated `session` configuration field; constraints follow the current source. |
Plugin Plan Optional Fields 1
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| configuration | field | source-defined | — | Validated `configuration` configuration field; constraints follow the current source. |
Plugin Component Fields 4
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| identity | field | source-defined | — | Validated `identity` configuration field; constraints follow the current source. |
| manifest_sha256 | field | source-defined | — | Validated `manifest_sha256` configuration field; constraints follow the current source. |
| variant | field | source-defined | — | Validated `variant` configuration field; constraints follow the current source. |
| version | field | source-defined | — | Validated `version` configuration field; constraints follow the current source. |
Config Component Lock Fields 13
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| api_version | field | source-defined | — | Validated `api_version` configuration field; constraints follow the current source. |
| capability_digest | field | source-defined | — | Validated `capability_digest` configuration field; constraints follow the current source. |
| config | field | source-defined | — | Validated `config` configuration field; constraints follow the current source. |
| distribution | field | source-defined | — | Validated `distribution` configuration field; constraints follow the current source. |
| distribution_version | field | source-defined | — | Validated `distribution_version` configuration field; constraints follow the current source. |
| entry_point_group | field | source-defined | — | Validated `entry_point_group` configuration field; constraints follow the current source. |
| entry_point_name | field | source-defined | — | Validated `entry_point_name` configuration field; constraints follow the current source. |
| entry_point_value | field | source-defined | — | Validated `entry_point_value` configuration field; constraints follow the current source. |
| identity | field | source-defined | — | Validated `identity` configuration field; constraints follow the current source. |
| manifest_sha256 | field | source-defined | — | Validated `manifest_sha256` configuration field; constraints follow the current source. |
| schema | field | source-defined | — | Configuration contract identifier; current Run files use fastsim/2. |
| variant | field | source-defined | — | Validated `variant` configuration field; constraints follow the current source. |
| version | field | source-defined | — | Validated `version` configuration field; constraints follow the current source. |
Plugin Configuration Lock Fields 3
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| components | field | source-defined | — | Validated `components` configuration field; constraints follow the current source. |
| preset | field | source-defined | — | Validated `preset` configuration field; constraints follow the current source. |
| schema | field | source-defined | — | Configuration contract identifier; current Run files use fastsim/2. |
Articulation Drive Fields 3
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| backend | field | source-defined | — | Name of the UniRoboSim Provider available in the project environment. |
| joints | field | source-defined | — | Validated `joints` configuration field; constraints follow the current source. |
| schema | field | source-defined | — | Configuration contract identifier; current Run files use fastsim/2. |
Base Component Origin Fields 5
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| component | field | source-defined | — | Validated `component` configuration field; constraints follow the current source. |
| kind | field | source-defined | — | Validated `kind` configuration field; constraints follow the current source. |
| manifest_sha256 | field | source-defined | — | Validated `manifest_sha256` configuration field; constraints follow the current source. |
| variant | field | source-defined | — | Validated `variant` configuration field; constraints follow the current source. |
| version | field | source-defined | — | Validated `version` configuration field; constraints follow the current source. |
Plugin Policy Fields 8
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| component | field | source-defined | — | Validated `component` configuration field; constraints follow the current source. |
| kind | field | source-defined | — | Validated `kind` configuration field; constraints follow the current source. |
| listed | field | source-defined | — | Validated `listed` configuration field; constraints follow the current source. |
| manifest_sha256 | field | source-defined | — | Validated `manifest_sha256` configuration field; constraints follow the current source. |
| policy_digest | field | source-defined | — | Validated `policy_digest` configuration field; constraints follow the current source. |
| policy_mode | field | source-defined | — | Validated `policy_mode` configuration field; constraints follow the current source. |
| policy_source | field | source-defined | — | Validated `policy_source` configuration field; constraints follow the current source. |
| selector_digest | field | source-defined | — | Validated `selector_digest` configuration field; constraints follow the current source. |
Explicit Override Fields 5
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| authoring_path | field | source-defined | — | Validated `authoring_path` configuration field; constraints follow the current source. |
| kind | field | source-defined | — | Validated `kind` configuration field; constraints follow the current source. |
| override_index | field | source-defined | — | Validated `override_index` configuration field; constraints follow the current source. |
| override_path | field | source-defined | — | Validated `override_path` configuration field; constraints follow the current source. |
| source | field | source-defined | — | Validated `source` configuration field; constraints follow the current source. |
Plugin Artifact Record Fields 6
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| cache_hit | field | source-defined | — | Validated `cache_hit` configuration field; constraints follow the current source. |
| format | field | source-defined | — | Validated `format` configuration field; constraints follow the current source. |
| local_path | field | source-defined | — | Validated `local_path` configuration field; constraints follow the current source. |
| requested_uri | field | source-defined | — | Validated `requested_uri` configuration field; constraints follow the current source. |
| resolved_uri | field | source-defined | — | Validated `resolved_uri` configuration field; constraints follow the current source. |
| sha256 | field | source-defined | — | Validated `sha256` configuration field; constraints follow the current source. |
Component Provenance Fields 4
| Field | Type | Constraint | Default | Description |
|---|---|---|---|---|
| component | field | source-defined | — | Validated `component` configuration field; constraints follow the current source. |
| manifest_sha256 | field | source-defined | — | Validated `manifest_sha256` configuration field; constraints follow the current source. |
| variant | field | source-defined | — | Validated `variant` configuration field; constraints follow the current source. |
| version | field | source-defined | — | Validated `version` configuration field; constraints follow the current source. |