Skip to content

Commit 4c91535

Browse files
authored
Updates documentation on Isaac Lab installation path for Windows (#1271)
# Description This update addresses a minor inconsistency found in the Isaac Lab installation documentation for Windows. While following the installation instructions on Isaac Lab for "Option 2: Installation using Isaac Sim binaries" on Windows, I encountered the following lines: > `C:\Users\%USERPROFILE%\AppData\Local\ov\pkg\isaac_sim-*`, with `*` corresponding to the Isaac Sim version. > `set ISAACSIM_PATH="C:\Users\%USERPROFILE%\AppData\Local\ov\pkg\isaac-sim-4.2.0"` This seemed redundant, as `%USERPROFILE%` already refers to the path `C:\Users\name_of_user`. I have compiled and verified the documentation changes to ensure proper display. Additionally, I tested this update on a Windows system, confirming that it works as intended. ## Type of change - 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 - [x] 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
1 parent 41a9dd4 commit 4c91535

File tree

4 files changed

+13
-3
lines changed

4 files changed

+13
-3
lines changed

CONTRIBUTORS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Guidelines for modifications:
5454
* Kaixi Bao
5555
* Kourosh Darvish
5656
* Lionel Gulich
57+
* Louis Le Lay
5758
* Lorenz Wellhausen
5859
* Masoud Moghani
5960
* Michael Gussert

docs/source/setup/installation/binaries_installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To check the minimum system requirements,refer to the documentation
3838
:sync: windows
3939

4040
On Windows systems, by default,Isaac Sim is installed in the directory
41-
``C:\Users\%USERPROFILE%\AppData\Local\ov\pkg\isaac_sim-*``, with ``*`` corresponding to the Isaac Sim version.
41+
``%USERPROFILE%\AppData\Local\ov\pkg\isaac_sim-*``, with ``*`` corresponding to the Isaac Sim version.
4242

4343
Verifying the Isaac Sim installation
4444
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -66,7 +66,7 @@ variables to your terminal for the remaining of the installation instructions:
6666
.. code:: batch
6767
6868
:: Isaac Sim root directory
69-
set ISAACSIM_PATH="C:\Users\%USERPROFILE%\AppData\Local\ov\pkg\isaac-sim-4.2.0"
69+
set ISAACSIM_PATH="%USERPROFILE%\AppData\Local\ov\pkg\isaac-sim-4.2.0"
7070
:: Isaac Sim python executable
7171
set ISAACSIM_PYTHON_EXE="%ISAACSIM_PATH:"=%\python.bat"
7272

source/extensions/omni.isaac.lab/config/extension.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22

33
# Note: Semantic Versioning is used: https://semver.org/
4-
version = "0.27.3"
4+
version = "0.27.4"
55

66
# Description
77
title = "Isaac Lab framework for Robot Learning"

source/extensions/omni.isaac.lab/docs/CHANGELOG.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
Changelog
22
---------
33

4+
0.27.4 (2024-10-18)
5+
~~~~~~~~~~~~~~~~~~~
6+
7+
Fixed
8+
^^^^^
9+
10+
* Updated installation path instructions for Windows in the Isaac Lab documentation to remove redundancy in the use of %USERPROFILE% for path definitions.
11+
12+
413
0.27.3 (2024-10-22)
514
~~~~~~~~~~~~~~~~~~~
615

0 commit comments

Comments
 (0)