Skip to content

Commit a4a7602

Browse files
authored
Clarifies kit-less installation in docs (#5045)
# Description Clarifies kit-less installation in docs and move it to its own page to be consistent with other installation methods. Hides Newton sim2sim and sim2real documentation as those examples are not yet available. ## Type of change - Documentation update ## Checklist - [x] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [ ] I have added my name to the `CONTRIBUTORS.md` or my name already exists there <!-- As you go through the checklist above, you can mark something as done by putting an x character in it For example, - [x] I have done this task - [ ] I have not done this task -->
1 parent b9b0e5f commit a4a7602

7 files changed

Lines changed: 132 additions & 396 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@ detailed tutorials and step-by-step guides. Follow these links to learn more abo
5656
- [Tutorials](https://isaac-sim.github.io/IsaacLab/main/source/tutorials/index.html)
5757
- [Available environments](https://isaac-sim.github.io/IsaacLab/main/source/overview/environments.html)
5858

59+
## Performance Dashboard
60+
61+
We continuously benchmark Isaac Lab across different physics backends, renderers, and data types.
62+
The **[Isaac Lab Performance Dashboard](https://nvidia.github.io/omniperf/)** provides interactive
63+
charts showing preset comparison results, performance history, and environment scaling data from
64+
our internal CI/CD benchmarks.
5965

6066
## Isaac Sim Version Dependency
6167

docs/source/experimental-features/newton-physics-integration/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ features for other reinforcement learning and imitation learning workflows in th
1717
a good lens through which to understand how Newton integration works in Isaac Lab.
1818

1919
We have validated Newton simulation against PhysX by transferring learned policies from Newton to PhysX and vice versa
20-
Furthermore, we have also successfully deployed a Newton-trained locomotion policy to a G1 robot. Please see :ref:`here <sim2real>` for more information.
20+
Furthermore, we have also successfully deployed a Newton-trained locomotion policy to a G1 robot.
2121

2222
Newton can support `multiple solvers <https://newton-physics.github.io/newton/latest/api/newton_solvers.html>`_ for handling different types of physics simulation, but for the moment, the Isaac
2323
Lab integration focuses primarily on the MuJoCo-Warp solver.
@@ -40,5 +40,3 @@ For an overview of how the multi-backend architecture works, including how to ad
4040
installation
4141
limitations-and-known-bugs
4242
solver-transitioning
43-
sim-to-sim
44-
sim-to-real

docs/source/experimental-features/newton-physics-integration/sim-to-real.rst

Lines changed: 0 additions & 92 deletions
This file was deleted.

docs/source/experimental-features/newton-physics-integration/sim-to-sim.rst

Lines changed: 0 additions & 171 deletions
This file was deleted.

docs/source/policy_deployment/02_gear_assembly/gear_assembly_policy.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -599,7 +599,6 @@ Further Resources
599599

600600
- `IndustReal: Transferring Contact-Rich Assembly Tasks from Simulation to Reality <https://arxiv.org/abs/2305.17110>`_
601601
- `FORGE: Force-Guided Exploration for Robust Contact-Rich Manipulation under Uncertainty <https://arxiv.org/abs/2408.04587>`_
602-
- Sim-to-Real Policy Transfer for Whole Body Controllers: :ref:`sim2real` - Shows how to train and deploy a whole body controller for legged robots using Isaac Lab with the Newton backend
603602
- `Isaac ROS Manipulation Documentation <https://nvidia-isaac-ros.github.io/reference_workflows/isaac_for_manipulation/index.html>`_
604603
- `Isaac ROS Gear Assembly Tutorial <https://nvidia-isaac-ros.github.io/reference_workflows/isaac_for_manipulation/tutorials/sim_to_real/tutorial_gear_assembly.html>`_
605604
- RL Training Tutorial: :ref:`tutorial-run-rl-training`

0 commit comments

Comments
 (0)