Commit b6afa8e
Fix OVD Recorder hanging silently on non-PhysX backends (#7507)
## Description
The OVD Recorder (`AnimationRecorder`) only works with the PhysX
backend, but most tasks now default to Newton. As a result,
`--anim_recording_enabled` silently did nothing: recording never
started, `--anim_recording_stop_time` was never reached, and the process
ran until manually killed with nothing saved.
This PR:
- Raises a clear error at simulation startup when
`--anim_recording_enabled` is set on a physics backend that doesn't
support the OVD Recorder (via a new
`PhysicsManager.supports_anim_recording` flag, set `True` only on
`PhysxManager`), naming the active backend and pointing the user to
`physics=isaacsim_physx`.
- Adds an `overrides` parameter to `parse_env_cfg()` so standalone
(non-Hydra) scripts can apply `physics=`/`renderer=`/`presets=`
overrides, and updates the `run_cartpole_rl_env.py` tutorial to forward
unrecognized CLI args this way.
- Updates `docs/source/how-to/record_animation.rst` to note the PhysX
requirement and fix the example command so it actually works as
documented.
## Type of change
- Bug fix (non-breaking change which fixes an issue)
## Testing
- Reran the exact documented repro command on the default (Newton)
backend: now fails fast with a clear `ValueError` instead of hanging.
- Reran with `physics=isaacsim_physx`: recording stops at
`--anim_recording_stop_time`, saves `baked_animation_recording.usda`,
process exits cleanly (exit code 0).
- `uv run isaaclab -f` passes for all touched files.
- Targeted tests (`test_physics_manager_lifecycle.py`, `test_hydra.py`):
94 passed.
- Docs build (`make -C docs current-docs`, warnings-as-errors):
succeeded with no warnings.
## Checklist
- [x] I have read and understood the contribution guidelines
- [x] I have run the `pre-commit` checks with `uv run isaaclab -f`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added a changelog fragment under
`source/<pkg>/changelog.d/` for every touched package
- [x] I have added my name to `CONTRIBUTORS.md` (already present)
## Release backport
- [x] <!-- backport-active-release --> Backport this pull request to the
active release branch after it merges into `develop`
(cherry picked from commit 69de9b2)1 parent 0305853 commit b6afa8e
22 files changed
Lines changed: 169 additions & 38 deletions
File tree
- docs/source/how-to
- scripts
- benchmarks
- environments
- state_machine
- teleoperation
- imitation_learning
- isaaclab_mimic
- locomanipulation_sdg
- gr00t
- robomimic
- tutorials/03_envs
- source
- isaaclab_physx
- changelog.d
- isaaclab_physx/physics
- isaaclab_tasks
- changelog.d
- isaaclab_tasks/utils
- test/core
- isaaclab
- changelog.d
- isaaclab/physics
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
97 | 97 | | |
98 | 98 | | |
99 | 99 | | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
100 | 110 | | |
101 | 111 | | |
102 | 112 | | |
| |||
120 | 130 | | |
121 | 131 | | |
122 | 132 | | |
123 | | - | |
| 133 | + | |
124 | 134 | | |
125 | 135 | | |
126 | 136 | | |
127 | 137 | | |
128 | 138 | | |
129 | 139 | | |
130 | | - | |
| 140 | + | |
131 | 141 | | |
132 | 142 | | |
133 | 143 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
236 | 236 | | |
237 | 237 | | |
238 | 238 | | |
239 | | - | |
| 239 | + | |
| 240 | + | |
240 | 241 | | |
241 | 242 | | |
242 | 243 | | |
| |||
527 | 528 | | |
528 | 529 | | |
529 | 530 | | |
530 | | - | |
| 531 | + | |
531 | 532 | | |
532 | 533 | | |
533 | 534 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
23 | | - | |
| 22 | + | |
| 23 | + | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| |||
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
47 | | - | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
48 | 50 | | |
49 | 51 | | |
50 | 52 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
33 | | - | |
| 32 | + | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| |||
257 | 257 | | |
258 | 258 | | |
259 | 259 | | |
| 260 | + | |
260 | 261 | | |
261 | 262 | | |
262 | 263 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
33 | | - | |
| 32 | + | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| |||
276 | 276 | | |
277 | 277 | | |
278 | 278 | | |
| 279 | + | |
279 | 280 | | |
280 | 281 | | |
281 | 282 | | |
| |||
Lines changed: 11 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
372 | 372 | | |
373 | 373 | | |
374 | 374 | | |
375 | | - | |
| 375 | + | |
| 376 | + | |
376 | 377 | | |
377 | 378 | | |
378 | 379 | | |
| |||
392 | 393 | | |
393 | 394 | | |
394 | 395 | | |
| 396 | + | |
395 | 397 | | |
396 | 398 | | |
397 | 399 | | |
| |||
1044 | 1046 | | |
1045 | 1047 | | |
1046 | 1048 | | |
1047 | | - | |
| 1049 | + | |
| 1050 | + | |
| 1051 | + | |
| 1052 | + | |
| 1053 | + | |
1048 | 1054 | | |
1049 | 1055 | | |
1050 | 1056 | | |
| |||
1083 | 1089 | | |
1084 | 1090 | | |
1085 | 1091 | | |
| 1092 | + | |
1086 | 1093 | | |
1087 | 1094 | | |
1088 | 1095 | | |
1089 | 1096 | | |
1090 | 1097 | | |
1091 | | - | |
| 1098 | + | |
1092 | 1099 | | |
1093 | 1100 | | |
1094 | 1101 | | |
| |||
1628 | 1635 | | |
1629 | 1636 | | |
1630 | 1637 | | |
| 1638 | + | |
1631 | 1639 | | |
1632 | 1640 | | |
1633 | 1641 | | |
| |||
Lines changed: 7 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | | - | |
56 | | - | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
57 | 61 | | |
58 | 62 | | |
59 | 63 | | |
| |||
195 | 199 | | |
196 | 200 | | |
197 | 201 | | |
198 | | - | |
| 202 | + | |
199 | 203 | | |
200 | 204 | | |
201 | 205 | | |
| |||
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
65 | | - | |
66 | | - | |
| 65 | + | |
| 66 | + | |
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
| |||
371 | 371 | | |
372 | 372 | | |
373 | 373 | | |
374 | | - | |
| 374 | + | |
375 | 375 | | |
376 | 376 | | |
377 | 377 | | |
| |||
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
123 | 123 | | |
124 | 124 | | |
125 | 125 | | |
126 | | - | |
| 126 | + | |
| 127 | + | |
127 | 128 | | |
128 | 129 | | |
129 | 130 | | |
| |||
993 | 994 | | |
994 | 995 | | |
995 | 996 | | |
996 | | - | |
| 997 | + | |
997 | 998 | | |
998 | 999 | | |
999 | 1000 | | |
| |||
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
| 35 | + | |
35 | 36 | | |
36 | 37 | | |
37 | 38 | | |
| |||
374 | 375 | | |
375 | 376 | | |
376 | 377 | | |
377 | | - | |
| 378 | + | |
378 | 379 | | |
379 | 380 | | |
380 | 381 | | |
| |||
0 commit comments