Updates docs - isaacsim package and example script#5054
Updates docs - isaacsim package and example script#5054kellyguo11 merged 2 commits intoisaac-sim:developfrom
Conversation
Update isaacsim install to workaround old mujoco-usd-converter converter on https://pypi.nvidia.com/mujoco-usd-converter/ Update installation test to use newton
Greptile SummaryThis PR updates the Newton physics integration installation documentation with two changes: (1) adds
Confidence Score: 4/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant User
participant uv as uv (package manager)
participant pypi_nvidia as pypi.nvidia.com
participant PyPI as pypi.org
participant IsaacLab as isaaclab.sh
User->>uv: uv pip install "isaacsim[all,extscache]==6.0.0"<br/>--extra-index-url https://pypi.nvidia.com<br/>--index-strategy unsafe-best-match<br/>--prerelease=allow
uv->>pypi_nvidia: Resolve isaacsim==6.0.0 and dependencies
uv->>PyPI: Resolve remaining dependencies (best match across indexes)
pypi_nvidia-->>uv: isaacsim packages
PyPI-->>uv: Other dependencies
uv-->>User: Installation complete
User->>IsaacLab: ./isaaclab.sh -p scripts/environments/zero_agent.py<br/>--task Isaac-Cartpole-Direct-v0<br/>--num_envs 128 --viz newton presets=newton
IsaacLab->>IsaacLab: parse_known_args() → --viz newton handled by AppLauncher
IsaacLab->>IsaacLab: presets=newton forwarded to Hydra as override
IsaacLab-->>User: Newton physics simulation running with Newton visualizer
Last reviewed commit: "update docs" |
| .. code-block:: bash | ||
|
|
||
| ./isaaclab.sh -p scripts/environments/zero_agent.py --task Isaac-Cartpole-Direct-v0 --num_envs 128 | ||
| ./isaaclab.sh -p scripts/environments/zero_agent.py --task Isaac-Cartpole-Direct-v0 --num_envs 128 --viz newton presets=newton No newline at end of file |
There was a problem hiding this comment.
Missing newline at end of file
The file no longer ends with a trailing newline (indicated by \ No newline at end of file in the diff). RST files conventionally end with a newline, and many pre-commit hooks (e.g. end-of-file-fixer) will flag this and prevent the commit from passing.
| ./isaaclab.sh -p scripts/environments/zero_agent.py --task Isaac-Cartpole-Direct-v0 --num_envs 128 --viz newton presets=newton | |
| ./isaaclab.sh -p scripts/environments/zero_agent.py --task Isaac-Cartpole-Direct-v0 --num_envs 128 --viz newton presets=newton |
|
|
||
| uv pip install "isaacsim[all,extscache]==6.0.0" --extra-index-url https://pypi.nvidia.com | ||
|
|
||
| uv pip install "isaacsim[all,extscache]==6.0.0" --extra-index-url https://pypi.nvidia.com --index-strategy unsafe-best-match --prerelease=allow |
There was a problem hiding this comment.
--prerelease=allow broadens scope beyond isaacsim
The --prerelease=allow flag instructs uv to allow pre-release versions for all packages resolved during this install, not just isaacsim. This means a pre-release version of an unrelated transitive dependency could be silently chosen over a stable release, potentially introducing instability.
If the intent is only to unblock isaacsim==6.0.0 (which itself is a specific pinned version), consider whether --prerelease=allow is strictly necessary — or add an inline comment to document why it's needed:
| uv pip install "isaacsim[all,extscache]==6.0.0" --extra-index-url https://pypi.nvidia.com --index-strategy unsafe-best-match --prerelease=allow | |
| uv pip install "isaacsim[all,extscache]==6.0.0" --extra-index-url https://pypi.nvidia.com --index-strategy unsafe-best-match --prerelease=allow |
At a minimum, consider adding a .. note:: block below explaining that these flags are a workaround for the old mujoco-usd-converter on pypi.nvidia.com, so future readers understand why they are present.
# Description Update isaacsim install to workaround old mujoco-usd-converter converter on https://pypi.nvidia.com/mujoco-usd-converter/ Update installation test to use newton ## Type of change - Documentation update ## Checklist - [ ] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [ ] I have made corresponding changes to the documentation - [ ] 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 -->
# Description Update isaacsim install to workaround old mujoco-usd-converter converter on https://pypi.nvidia.com/mujoco-usd-converter/ Update installation test to use newton ## Type of change - Documentation update ## Checklist - [ ] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [ ] I have made corresponding changes to the documentation - [ ] 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 -->
# Description Update isaacsim install to workaround old mujoco-usd-converter converter on https://pypi.nvidia.com/mujoco-usd-converter/ Update installation test to use newton ## Type of change - Documentation update ## Checklist - [ ] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [ ] I have made corresponding changes to the documentation - [ ] 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 -->
# Description Update isaacsim install to workaround old mujoco-usd-converter converter on https://pypi.nvidia.com/mujoco-usd-converter/ Update installation test to use newton ## Type of change - Documentation update ## Checklist - [ ] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [ ] I have made corresponding changes to the documentation - [ ] 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 -->
Description
Update isaacsim install to workaround old mujoco-usd-converter converter on https://pypi.nvidia.com/mujoco-usd-converter/
Update installation test to use newton
Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there