Skip to content

Refresh native demos and separate focused examples - #8751

Draft
maxkra15 wants to merge 7 commits into
isaac-sim:mainfrom
maxkra15:maximiliank/fix-docs-demos-screenshots-example-list
Draft

maxkra15 wants to merge 7 commits into
isaac-sim:mainfrom
maxkra15:maximiliank/fix-docs-demos-screenshots-example-list

Conversation

@maxkra15

Copy link
Copy Markdown
Contributor

Description

The native demo gallery used browser-demo pictures for MicroDuck Warehouse and SONIC, retained a previous card's backend selection, and listed three focused examples as demos. This refreshes the previews and launch commands, expands the Zoo from five to twenty robot models, and moves the focused programs into the example catalog.

  • Default MicroDuck Warehouse to Newton MJWarp and Newton GL, retain PhysX as an option, and list compatible visualizers for each backend.
  • Reset physics and visualizer defaults when selecting a demo. Include the CUDA PyTorch backend and SONIC's model-download/inference dependencies in copied commands.
  • Replace MicroDuck and SONIC placeholders with native captures. The SONIC image comes from the verified Newton MPM + Kit walk across gravel and sand.
  • Arrange twenty Zoo models across display rows and stands, with gentle joint motion and a hovering Crazyflie. Add display-specific anchoring and actuator settings for stable MJWarp/PhysX playback, and an optional GL exposure setting for the updated lighting.
  • Move Newton Block and Tackle, Snowball Smash, and Teapot Fill into examples, including their scripts, thumbnails, catalog entries, references, and existing test cases.

Screenshots

Zoo: previous preview and expanded showcase

Previous documentation thumbnail Twenty-model Zoo with adjusted exposure
Previous Zoo thumbnail Expanded twenty-model Zoo

The expanded scene includes H1, G1, GR1T2, ANYmal, Spot, Go2, A1, Franka, UR10/UR10e, KUKA-Allegro, Sawyer, Kinova Gen3, Jaco, Flexiv Rizon, Shadow and Allegro hands, MicroDuck, SO-101, and Crazyflie.

Native demo previews

MicroDuck Warehouse SONIC: G1 walking from gravel into sand
Native MicroDuck Warehouse Native SONIC Newton MPM and Kit capture

Command migration

These three programs now use isaaclab example; their scripts move from examples/demos/ to examples/. The changelog records the breaking CLI change.

Previous command Replacement
isaaclab demo newton-block-and-tackle isaaclab example newton-block-and-tackle
isaaclab demo snowball-smash isaaclab example snowball-smash
isaaclab demo teapot-fill isaaclab example teapot-fill

Validation

  • Full uv run --no-sync isaaclab --format and changelog validation against origin/main passed.
  • Clean uv run --no-sync isaaclab --docs build passed with warnings treated as errors.
  • Browser checks passed for backend/visualizer defaults, native thumbnails, and demo/example classification.
  • 43 focused checks passed: 35 CLI/catalog checks, six standalone discovery/docs/prelaunch contracts, and two moved-MPM import cases. Existing tests were updated at their owning boundaries; no duplicate simulation tests were added.
  • Zoo native validation: 900 steps on MJWarp and PhysX, including reset at step 800; a two-environment MJWarp clone run also passed. MJWarp reported no solver-capacity overflows. These results were reused after confirming the final Zoo code is semantically unchanged and incoming main changes do not affect its physics/rendering path.
  • Native previews were visually inspected. The SONIC capture was also fully decoded and verified at 3840×2160, 50 fps, 940 frames / 18.8 seconds.

Type of change

  • Bug fix
  • New feature
  • Breaking change: the three focused programs require isaaclab example instead of isaaclab demo.
  • Documentation update

Release backport

  • Backport this pull request to the active release branch after it merges into main

Checklist

  • I have read and understood the contribution guidelines.
  • I have run the pre-commit checks with uv run isaaclab --format.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings in the completed checks.
  • I have validated the changed behavior with focused coverage and applied the test-audit criteria to test changes.
  • I have added a changelog fragment for every touched source package.
  • My name already exists in CONTRIBUTORS.md.

@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation isaac-lab Related to Isaac Lab team labels Oct 20, 2026
Merge main at 46d6cc3 and reconcile
the focused example relocation with current visualizer configuration.

Keep released demo commands and script entry points working through a
deprecation period while the examples remain the canonical discovery path.
Keep this branch current with upstream main at
e4df255. Preserve the PR behavior.
Integrate upstream main e907f82
to keep this branch current while preserving its feature scope.
Integrate upstream main d78054a
to retain compatibility with current backend ownership and dependencies.
Integrate upstream main at ce2900d to keep
the branch current with shared API and dependency changes.

Validate the merged revision with focused checks and full formatting
and lint hooks before committing. Remote CI remains separate.
Integrate upstream main at 6d37745 to keep
the branch current with shared API and dependency changes.

Validate the merged revision with focused checks and all repository
formatting and lint hooks. Remote CI remains separate.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation isaac-lab Related to Isaac Lab team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant