Updates pip installation documentation to clarify options #1621
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As a first time user, I skipped over the sim part at first because I wanted lab - clarify that sim is required. Rename anchors from sim to lab. Move the notes about miniconda to where conda is actually used. Clarify that there are two options for installation. Otherwise, a user progressing in order will run the full installation, and then discover that a minimal installation would have been an option. Use separate attention boxes for the two separate items. Note: I was able to follow these instructions on Ubuntu24 with a minimal hack to force python3.10 instead of the default 3.12.
steple
requested review from
Dhoeller19,
Mayankm96,
jsmith-bdai and
kellyguo11
as code owners
kellyguo11
changed the title
hapatel-bdai
pushed a commit
that referenced
this pull request
Jan 21, 2025
# Description - As a first time user, I skipped over the sim part at first because I wanted lab - clarify that sim is required. - Rename anchors from sim to lab. - Move the notes about miniconda to where conda is actually used. - Clarify that there are two options for installation. Otherwise, a user progressing in order will run the full installation, and then discover that a minimal installation would have been an option. - Use separate attention boxes for the two separate items. Note: I was able to follow the pip instructions on Ubuntu24 with a minimal hack to force python3.10 instead of the default 3.12. I have not tried the binary installation instructions. ## Type of change Documentation only. ## Checklist I have built the documentation locally. - [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 - _n/a_ - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - _Does not affect an extension._ - [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 -->
SevenFo
pushed a commit
to SevenFo/IsaacLab
that referenced
this pull request
May 19, 2025
…1621) # Description - As a first time user, I skipped over the sim part at first because I wanted lab - clarify that sim is required. - Rename anchors from sim to lab. - Move the notes about miniconda to where conda is actually used. - Clarify that there are two options for installation. Otherwise, a user progressing in order will run the full installation, and then discover that a minimal installation would have been an option. - Use separate attention boxes for the two separate items. Note: I was able to follow the pip instructions on Ubuntu24 with a minimal hack to force python3.10 instead of the default 3.12. I have not tried the binary installation instructions. ## Type of change Documentation only. ## Checklist I have built the documentation locally. - [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 - _n/a_ - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - _Does not affect an extension._ - [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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Note: I was able to follow the pip instructions on Ubuntu24 with a minimal hack to force python3.10 instead of the default 3.12. I have not tried the binary installation instructions.
Type of change
Documentation only.
Checklist
I have built the documentation locally.
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfile - Does not affect an extension.CONTRIBUTORS.mdor my name already exists there