Skip to content

Fixs isaaclab.sh to detect isaacsim_version accurately 4.5 or >= 5.0 #3139

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

Merged
merged 1 commit into from
Aug 12, 2025

Conversation

ooctipus
Copy link
Collaborator

@ooctipus ooctipus commented Aug 10, 2025

Description

Current is_isaacsim_version_4_5() sometimes mis-detects 5.0 when running 4.5 (e.g., Docker/symlinked installs), causing the conda bootstrap to pick Python 3.11 instead of 3.10.

This pr ensures determining the isaacsim version following below steps

  1. Read ${ISAACLAB_PATH}/_isaac_sim/VERSION (symlink/binary install).

  2. If unknown, import isaacsim and read ../../VERSION next to the package. (pip installation)

  3. If still unknown, fall back to importlib.metadata.version("isaacsim").

I tested locally to work with 4.5 pip or binary install.

  • Bug fix (non-breaking change which fixes an issue)

Screenshots

Please attach before and after screenshots of the change if applicable.

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

@ooctipus ooctipus changed the title Fix/isaac lab sh 4.5 compatibility Fixs isaaclab.sh to detect isaacsim_version accurately 4.5 or >= 5.0 Aug 10, 2025
Copy link

Test Results Summary

2 419 tests   2 011 ✅  2h 16m 43s ⏱️
   90 suites    408 💤
    1 files        0 ❌

Results for commit 8958d76.

@@ -43,33 +43,48 @@ install_system_deps() {
fi
}

# Returns success (exit code 0 / "true") if the detected Isaac Sim version starts with 4.5,
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the fix. Does the isaaclab.bat file also need to be adapted?

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we should convert these shell/bat scripts to a python file to simplify the maintainance work between different OS platforms.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, I think people generally also understand python more than bash.
Though I wonder if using python, could it be a lot more verbose than writing bash.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I checked the isaaclab.bat, its checking workflow is good, and also worked with windows, so I think no need for now

@ooctipus ooctipus merged commit f70e695 into main Aug 12, 2025
10 checks passed
@ooctipus ooctipus deleted the fix/isaac_lab_sh_4.5_compatibility branch August 12, 2025 20:19
@ooctipus ooctipus restored the fix/isaac_lab_sh_4.5_compatibility branch August 13, 2025 20:56
StephenWelch pushed a commit to StephenWelch/IsaacLab that referenced this pull request Aug 17, 2025
…saac-sim#3139)

# Description

Current is_isaacsim_version_4_5() sometimes mis-detects 5.0 when running
4.5 (e.g., Docker/symlinked installs), causing the conda bootstrap to
pick Python 3.11 instead of 3.10.

This pr ensures determining the isaacsim version following below steps

1. Read ${ISAACLAB_PATH}/_isaac_sim/VERSION (symlink/binary install).

2. If unknown, import isaacsim and read ../../VERSION next to the
package. (pip installation)

3. If still unknown, fall back to
importlib.metadata.version("isaacsim").

I tested locally to work with 4.5 pip or binary install.

<!-- As you go through the list, delete the ones that are not
applicable. -->

- Bug fix (non-breaking change which fixes an issue)

## Screenshots

Please attach before and after screenshots of the change if applicable.

<!--
Example:

| Before | After |
| ------ | ----- |
| _gif/png before_ | _gif/png after_ |

To upload images to a PR -- simply drag and drop an image while in edit
mode and it should upload the image directly. You can then paste that
source into the above before/after sections.
-->

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [ ] 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
- [x] 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

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

Successfully merging this pull request may close these issues.

2 participants