Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

KyleM73
Copy link
Contributor

@KyleM73 KyleM73 commented Aug 14, 2025

Description

This PR adds support for uv as an alternative to conda for managing python dependencies. Uv 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!

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

Copy link
Contributor

@Mayankm96 Mayankm96 left a comment

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!

@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
Copy link
Contributor Author

KyleM73 commented Aug 17, 2025

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
Copy link
Contributor Author

KyleM73 commented Aug 17, 2025

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants