Skip to content

Improves installation UX and documentation for Kit-less and uv flows#4879

Merged
myurasov-nv merged 38 commits intoisaac-sim:developfrom
rdsa-nv:user/ruben/installation
Mar 11, 2026
Merged

Improves installation UX and documentation for Kit-less and uv flows#4879
myurasov-nv merged 38 commits intoisaac-sim:developfrom
rdsa-nv:user/ruben/installation

Conversation

@rdsa-nv
Copy link
Copy Markdown
Contributor

@rdsa-nv rdsa-nv commented Mar 8, 2026

Description

Improvements to the installation and documentation within UV and Kit-less pathways in mind.

CLI fixes:

  • More reliable installation detection (using "import isaaclab").
  • Handle case w/no IsaacSim symlinked.
  • "pip" / "uv pip" command selection based on environment.
  • Unit test for cli utils and uv install commands.

Docs:

  • Add "Installation Configurations" section to installation index explaining the Kit vs Kit-less and PhysX vs Newton axes, with a common install paths table
  • Add "Install Options Reference" table listing all accepted -i tokens
  • Add "Selecting the Physics Backend" subsection to the quickstart guide with presets=newton/physx and --visualizer examples
  • Sync --help output in docs with updated CLI (visualizers, ovrtx, visualizer selector syntax)

Type of change

  • Bug fixes
  • Improvements
  • Test
  • Documentation update

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks 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 Ruben DS'a-s to the CONTRIBUTORS.md or my name already exists there

@github-actions github-actions Bot added the isaac-lab Related to Isaac Lab team label Mar 8, 2026
Comment thread source/isaaclab/isaaclab/sensors/camera/camera_cfg.py Outdated
Comment thread INSTALLATION.md Outdated
Comment thread source/isaaclab/isaaclab/sim/simulation_context.py
Comment thread source/isaaclab/test/cli/test_install.py
Comment thread INSTALLATION.md Outdated
Comment thread source/isaaclab/isaaclab/cli/utils.py Outdated
Comment thread source/isaaclab/isaaclab/cli/utils.py
@myurasov-nv myurasov-nv force-pushed the user/ruben/installation branch from 23a56e0 to eca2916 Compare March 10, 2026 01:04
@myurasov-nv myurasov-nv marked this pull request as draft March 10, 2026 01:04
@myurasov-nv myurasov-nv force-pushed the user/ruben/installation branch from d1ba3e3 to a938c52 Compare March 10, 2026 05:15
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Mar 10, 2026
@myurasov-nv myurasov-nv force-pushed the user/ruben/installation branch from e54b9b3 to 94fe85a Compare March 10, 2026 06:06
@myurasov-nv myurasov-nv marked this pull request as ready for review March 10, 2026 06:48
@myurasov-nv myurasov-nv changed the title Improve Lab Installation Improves installation and documentation for Kit-less and uv install Mar 10, 2026
@myurasov-nv myurasov-nv changed the title Improves installation and documentation for Kit-less and uv install Improves installation and documentation for Kit-less and uv flows Mar 10, 2026
@myurasov-nv myurasov-nv changed the title Improves installation and documentation for Kit-less and uv flows Improves installation UX and documentation for Kit-less and uv flows Mar 10, 2026
Comment thread source/isaaclab/isaaclab/cli/commands/install.py
Comment thread source/isaaclab/test/cli/test_install.py Outdated
Comment thread docs/source/setup/installation/index.rst Outdated
@myurasov-nv myurasov-nv force-pushed the user/ruben/installation branch from 394c1cd to 6df095d Compare March 10, 2026 06:53
@isaac-sim isaac-sim deleted a comment from greptile-apps Bot Mar 10, 2026
@myurasov-nv
Copy link
Copy Markdown
Member

@greptile-apps

Comment thread docs/source/setup/installation/index.rst Outdated
Comment thread source/isaaclab/test/cli/test_install.py Outdated
@isaac-sim isaac-sim deleted a comment from greptile-apps Bot Mar 10, 2026
@myurasov-nv
Copy link
Copy Markdown
Member

@greptile-apps

Comment thread source/isaaclab/isaaclab/cli/commands/install.py Outdated
@isaac-sim isaac-sim deleted a comment from greptile-apps Bot Mar 10, 2026
@myurasov-nv
Copy link
Copy Markdown
Member

@greptile-aps

myurasov-nv and others added 25 commits March 10, 2026 23:35
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Signed-off-by: myurasov-nv <168484206+myurasov-nv@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Signed-off-by: myurasov-nv <168484206+myurasov-nv@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Signed-off-by: myurasov-nv <168484206+myurasov-nv@users.noreply.github.com>
@myurasov-nv myurasov-nv force-pushed the user/ruben/installation branch from 2cf1309 to c78d387 Compare March 11, 2026 06:36
Copy link
Copy Markdown
Collaborator

@ooctipus ooctipus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @myurasov-nv

@myurasov-nv
Copy link
Copy Markdown
Member

thank you @rdsa-nv !

@myurasov-nv myurasov-nv merged commit 07756a5 into isaac-sim:develop Mar 11, 2026
8 of 10 checks passed
daniela-hase pushed a commit to daniela-hase/IsaacLab that referenced this pull request Mar 30, 2026
…saac-sim#4879)

# Description

Improvements to the installation and documentation within UV and
Kit-less pathways in mind.

**CLI fixes:**
- More reliable installation detection (using "import isaaclab").
- Handle case w/no IsaacSim symlinked.
- "pip" / "uv pip" command selection based on environment.
- Unit test for cli utils and uv install commands.

**Docs:**
- Add "Installation Configurations" section to installation index
explaining the Kit vs Kit-less and PhysX vs Newton axes, with a common
install paths table
- Add "Install Options Reference" table listing all accepted `-i` tokens
- Add "Selecting the Physics Backend" subsection to the quickstart guide
with `presets=newton/physx` and `--visualizer` examples
- Sync `--help` output in docs with updated CLI (`visualizers`, `ovrtx`,
visualizer selector syntax)

## Type of change

- Bug fixes
- Improvements
- Test
- 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
- [x] 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
- [x] I have added Ruben DS'a-s to the `CONTRIBUTORS.md` or my name
already exists there

---------

Signed-off-by: myurasov-nv <168484206+myurasov-nv@users.noreply.github.com>
Co-authored-by: Mikhail Yurasov <myurasov@nvidia.com>
Co-authored-by: myurasov-nv <168484206+myurasov-nv@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

4 participants