Skip to content

Adds uv support as an alternative to conda in isaaclab.sh - #3172

Merged
Mayankm96 merged 25 commits into
isaac-sim:mainfrom
KyleM73:feature/uv
Sep 11, 2025
Merged

Mayankm96 merged 25 commits into
isaac-sim:mainfrom
KyleM73:feature/uv

Conversation

@KyleM73

@KyleM73 KyleM73 commented Aug 14, 2025 •

Copy link
Copy Markdown
Contributor

Description

This PR adds support for uv as an alternative to conda or venv for managing virtual environments and adds corresponding support for uv pip for managing python dependencies. uv and uv pip is significantly faster than conda and has many useful tools.

If users wish to use the uv workflow they will need to have uv installed, but otherwise no additional dependencies are added.

Docs should be updated to describe this option. There may need to be more work done to clean when deactivating the environment. Uv does not support pre and post activation hooks like conda so cleaning up the environment variables is slightly more tricky. I would greatly appreciate feedback to improve this workflow!

Fixes #3408

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

Checklist

  • 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 my name to the CONTRIBUTORS.md or my name already exists there

@Mayankm96 Mayankm96 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Mainly NITs. Could you also update the setup instructions for UV? :)

It would be good to extend the support to Windows. If you don't have access to a Windows machine, could you please make a ticket so our team can look into it? Thank you!

Comment thread isaaclab.sh Resolved
Comment thread isaaclab.sh Resolved
Comment thread isaaclab.sh Resolved
@Mayankm96
Mayankm96 requested a review from Toni-SM August 16, 2025 04:57
@Mayankm96 Mayankm96 added the enhancement New feature or request label Aug 16, 2025
KyleM73 and others added 5 commits August 16, 2025 08:58
Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
@KyleM73
KyleM73 requested a review from jtigue-bdai as a code owner August 17, 2025 03:32
@KyleM73

KyleM73 commented Aug 17, 2025

Copy link
Copy Markdown
Contributor Author

I'm working on updating the docs accordingly. I don'y have access to a Windows machine so would greatly appreciate some help setting it up in the .bat file. uv is supported on Windows so the setup should be similar.

Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
@KyleM73

KyleM73 commented Aug 17, 2025

Copy link
Copy Markdown
Contributor Author

Ok I believe the docs have been updated as needed. Only the .bat needs to be updated. The uv install should be the same as linux, just the terminal commands for Windows is different (and maybe the method I'm using to alias isaaclab when in the venv). Since I can't test it I haven't edited the .bat file at all.

@KyleM73
KyleM73 requested a review from Mayankm96 August 17, 2025 22:21
@Mayankm96

Copy link
Copy Markdown
Contributor

@kellyguo11 shall we go ahead and merge this? We can make a separate MR on support for Windows.

@Toni-SM

Toni-SM commented Aug 28, 2025

Copy link
Copy Markdown
Contributor

This PR adds support for uv as an alternative to conda for managing python dependencies.

I want to say that no conda nor uv is used for managing python dependencies (what it actually does that is pip) but just creating virtual Python environments... where you need to install a third-party manager for this purpose 😅

@KyleM73

KyleM73 commented Aug 28, 2025 •

Copy link
Copy Markdown
Contributor Author

This PR adds support for uv as an alternative to conda for managing python dependencies.

I want to say that no conda nor uv is used for managing python dependencies (what it actually does that is pip) but just creating virtual Python environments... where you need to install a third-party manager for this purpose 😅

For conda yes, here I actually use uv pip to perform the installs which is why it is so much faster- it is using uv's resolver instead of the default pip resolver. uv pip isn't just pip under the hood. Maybe the more accurate description of the PR is that it adds uv as an alternative to conda and venv for creating virtual environments and adds uv pip as an alternative to pip for python package management.

@Toni-SM

Toni-SM commented Aug 28, 2025 •

Copy link
Copy Markdown
Contributor

adds uv pip as an alternative to pip for python package management.

If this is the case, then, please also update the following files to use uv pip (or up add) to install the Python packages on an uv setup

Added note for users of 'uv' regarding pip replacement.

Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
@KyleM73

KyleM73 commented Aug 28, 2025

Copy link
Copy Markdown
Contributor Author

Done! I added a note that uv users should use its version of pip. However, using regular pip is also fine too; the uv virtual environment still encapsulates it. Regular pip will just be slower to install (but otherwise the same).

@kellyguo11

Copy link
Copy Markdown
Contributor

@KyleM73 could you help resolve the conflict and run through the formatter again?

@hhansen-bdai hhansen-bdai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎉 Thanks, @KyleM73!

@KyleM73

KyleM73 commented Sep 10, 2025 •

Copy link
Copy Markdown
Contributor Author

I merged IsaacLab main into the branch and made sure all formatter tests were passing! Thanks for the help getting this over the line :)

edit: one sec need to push a bug fix, testing all the options in isaaclab.sh
edit 2: fixed!

@KyleM73

KyleM73 commented Sep 10, 2025 •

Copy link
Copy Markdown
Contributor Author

Timing comparison:

TLDR:
uv gets 10x speed up with caching, vs. conda sees virtually no improvement.

uv is 2x as fast as conda without caching, and with caching, uv is nearly 30x faster for reinstalls.

uv (no torch cache):

uv cache clean
./isaaclab.sh --uv ilab
source ilab/bin/activate
isaaclab -i

real 3m3.427s
user 0m47.334s
sys 0m14.178s

uv (torch cached)

rm -rf ilab/
./isaaclab.sh --uv ilab
source ilab/bin/activate
isaaclab -i

real 0m13.632s
user 0m10.912s
sys 0m2.760s

conda (no torch cache):

conda clean --all
./isaaclab.sh --conda ilab
conda activate ilab
isaaclab -i

real 6m9.684s
user 5m48.326s
sys 0m8.500s

conda (torch cached):

conda env remove --name ilab
./isaaclab.sh --conda ilab
conda activate ilab
isaaclab -i

real 6m12.353s
user 5m48.358s
sys 0m8.008s

Note: I have a few custom extensions that were installed as well, but the timing should be representative since both install methods performed the same installations. tests were run on an Ubuntu 22.04 system with Intel 10900K CPU and 3080 12Gb GPU. Clearing caches was not included in the reported times- the times are just for creating the virtual environment and installing IsaacLab with all rl frameworks.

@github-actions github-actions Bot added documentation Improvements or additions to documentation infrastructure labels Sep 11, 2025
@Mayankm96

Copy link
Copy Markdown
Contributor

Adds issue #3438 to track for windows.

Thanks again for the great work and benchmarking! We should at some point just default to UV for installation and make conda a second option for users.

@Mayankm96

Copy link
Copy Markdown
Contributor

Sorry for missing this earlier but can you also add the license for UV inside docs/licenses. Hopefully that's the last step now and we can merge.

@KyleM73

KyleM73 commented Sep 11, 2025

Copy link
Copy Markdown
Contributor Author

done!

Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
@Mayankm96
Mayankm96 merged commit d5d5711 into isaac-sim:main Sep 11, 2025
ooctipus pushed a commit to ooctipus/IsaacLab that referenced this pull request Sep 20, 2025
…3172)

# Description

This PR adds support for uv as an alternative to conda or venv for
managing virtual environments and adds corresponding support for uv pip
for managing python dependencies. uv and uv pip is significantly faster
than conda and has many useful tools.

If users wish to use the uv workflow they will need to have uv
installed, but otherwise no additional dependencies are added.

Docs should be updated to describe this option. There may need to be
more work done to clean when deactivating the environment. Uv does not
support pre and post activation hooks like conda so cleaning up the
environment variables is slightly more tricky. I would greatly
appreciate feedback to improve this workflow!

Fixes isaac-sim#3408

## Type of change

- New feature (non-breaking change which adds functionality)
- This change requires a documentation update


## Checklist

- [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
- [X] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

---------

Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
george-nehma pushed a commit to george-nehma/DreamLander-IsaacLab that referenced this pull request Oct 24, 2025
…3172)

# Description

This PR adds support for uv as an alternative to conda or venv for
managing virtual environments and adds corresponding support for uv pip
for managing python dependencies. uv and uv pip is significantly faster
than conda and has many useful tools.

If users wish to use the uv workflow they will need to have uv
installed, but otherwise no additional dependencies are added.

Docs should be updated to describe this option. There may need to be
more work done to clean when deactivating the environment. Uv does not
support pre and post activation hooks like conda so cleaning up the
environment variables is slightly more tricky. I would greatly
appreciate feedback to improve this workflow!

Fixes isaac-sim#3408

## Type of change

- New feature (non-breaking change which adds functionality)
- This change requires a documentation update


## Checklist

- [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
- [X] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

---------

Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
hougantc-nvda pushed a commit to hougantc-nvda/IsaacLab that referenced this pull request Oct 24, 2025
…3172)

This PR adds support for uv as an alternative to conda or venv for
managing virtual environments and adds corresponding support for uv pip
for managing python dependencies. uv and uv pip is significantly faster
than conda and has many useful tools.

If users wish to use the uv workflow they will need to have uv
installed, but otherwise no additional dependencies are added.

Docs should be updated to describe this option. There may need to be
more work done to clean when deactivating the environment. Uv does not
support pre and post activation hooks like conda so cleaning up the
environment variables is slightly more tricky. I would greatly
appreciate feedback to improve this workflow!

Fixes isaac-sim#3408

- New feature (non-breaking change which adds functionality)
- This change requires a documentation update

- [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
- [X] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

---------

Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
LJones-alt pushed a commit to LJones-alt/IsaacLab-Laura that referenced this pull request Jul 1, 2026
…3172)

# Description

This PR adds support for uv as an alternative to conda or venv for
managing virtual environments and adds corresponding support for uv pip
for managing python dependencies. uv and uv pip is significantly faster
than conda and has many useful tools.

If users wish to use the uv workflow they will need to have uv
installed, but otherwise no additional dependencies are added.

Docs should be updated to describe this option. There may need to be
more work done to clean when deactivating the environment. Uv does not
support pre and post activation hooks like conda so cleaning up the
environment variables is slightly more tricky. I would greatly
appreciate feedback to improve this workflow!

Fixes isaac-sim#3408

## Type of change

- New feature (non-breaking change which adds functionality)
- This change requires a documentation update


## Checklist

- [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
- [X] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

---------

Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Co-authored-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
csj-275 pushed a commit to csj-275/IsaacLab that referenced this pull request Jul 8, 2026
…3172)

# Description

This PR adds support for uv as an alternative to conda or venv for
managing virtual environments and adds corresponding support for uv pip
for managing python dependencies. uv and uv pip is significantly faster
than conda and has many useful tools.

If users wish to use the uv workflow they will need to have uv
installed, but otherwise no additional dependencies are added.

Docs should be updated to describe this option. There may need to be
more work done to clean when deactivating the environment. Uv does not
support pre and post activation hooks like conda so cleaning up the
environment variables is slightly more tricky. I would greatly
appreciate feedback to improve this workflow!

Fixes isaac-sim#3408

## Type of change

- New feature (non-breaking change which adds functionality)
- This change requires a documentation update


## Checklist

- [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
- [X] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

---------

Signed-off-by: Kyle Morgenstein <34984693+KyleM73@users.noreply.github.com>
Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Co-authored-by: Mayank Mittal <12863862+Mayankm96@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 enhancement New feature or request infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Proposal] Support for uv virtual environments – Updated installation script provided

5 participants