Improvement Suggestions for Isaac Lab Installation Documentation

[hskang.py]

Improvements are needed for the Isaac Lab documentation. Two installation methods are provided at the link below:
https://isaac-sim.github.io/IsaacLab/source/setup/installation/index.html

1. pip install method

The installation method suggested is not sufficient on its own. The following process must be completed first:
https://docs.omniverse.nvidia.com/isaacsim/latest/installation/install_python.html

pip install isaacsim==4.0.0.0 --extra-index-url https://pypi.nvidia.com

Even after successfully completing this process, using it for development proves difficult.

The link below includes information about installation through the Omniverse Launcher, which is not necessary for development:
https://isaac-sim.github.io/IsaacLab/source/setup/developer.html

However, the use is hindered as autocomplete or IntelliSense support for related libraries is lacking.

Performing setup_python_env properly is impossible without the _isaac_sim symbolic link. While someone who has read Isaac Sim installed from binaries thoroughly would understand, those who have only seen the pip installation guide might find it difficult. The documentation needs clearer explanations.

2. using binaries install method

It is hard to discern the intent behind the Omniverse Launcher URL provided:
https://docs.omniverse.nvidia.com/isaacsim/latest/installation/install_workstation.html#workstation-installation

As demonstrated by the following post, there is confusion about what needs to be downloaded, necessitating improvements:

Unable to locate Omniverse Launcher download

Hey, I am just trying to get started with Omniverse and already failing on the first step - locating where I can download the launcher from. The official Nvidia page has just a “Platform SDK” and “Cloud APIs” options, and all launcher links from official tutorials lead to this SDK (kit-sdk-public@106.0.0-prod.2+master.161.c5fde6d1.gl.windows-x86_64.release). My understanding is that I need an Omniverse Launcher Installer, not an SDK. Am I missing something? [image]

Furthermore, even after launching, installing version 4.0 is challenging as it is not the default and is hidden:

Description in Exchange says 4.0, launcher installs 2023.1 anyway

Launcher seems to be offering the wrong files? New user trying to install Isaac Sim 4.0 workstation using the launcher as described here: Workstation Installation — Omniverse IsaacSim latest documentation Searching for Isaac in launcher → ‘Exchange’ it appears twice but both only offer 2023.1 even though the description text for one of them says it’s version 4.0. The pulldown menu next to the install button doesn’t offer 4.0 as an option. How can Isaac Sim 4.0 be installed using the launcher?…

This oversight may have been mine, but clearer information regarding the need for Isaac Sim 4.0 when using the Isaac Lab would be appreciated. Since the previous versions were labeled as 2023.1.1, etc., I did not realize a different version was necessary.

[evanzijianhe]

I totally agree with you that the documentation is confused.

I went over the instructions from both isaac lab and isaac sim. I successfully installed both isaac lab and sim through pip install method. I did not run the setup_python_env in the vscode, but I could run the examples from isaac lab folders. I am not sure if it is necessary to run this command if we are using pip install method to install isaac sim.

If we used pip install method, do we still need to install the isaac sim in the omniuniverse-launch? If not, we probably do not have _isaac_sim.

I also noticed that from omni.isaac.lab.app import AppLauncher is not defined, but the code can be executed. Probably I still made some mistakes during the installation.

[user159739]

Hi there. I agree at this point I am confused.
I had installed Isaac Sim 4.1.0 from the launcher on Windows.
Now I wish to install Isaac Lab.
But, exactly where do I start???
I have ROS2 Humble installed as well. I have successfully started up Isaac Sim 4.1.0 and the ROS2 bridge was enabled. Then I shut that down.
So, I cloned Isaac Lab into my ROS2 workspace (C:\isaac_ws\src)?
Created the Isaac Sim Symbolic Link.
Then tried to run isaaclab.bat --install:

C:\isaac_ws\src\IsaacLab>isaaclab.bat --install
[INFO] Installing extensions inside the Isaac Lab repository…
“C:\isaac_ws\src\IsaacLab\source\extensions\omni.isaac.lab”
module: “C:\isaac_ws\src\IsaacLab\source\extensions\omni.isaac.lab”
C:\isaac_ws\src\IsaacLab_isaac_sim\kit\python\kit.exe: No module named pip
There was an error running python.
“C:\isaac_ws\src\IsaacLab\source\extensions\omni.isaac.lab_assets”
module: “C:\isaac_ws\src\IsaacLab\source\extensions\omni.isaac.lab_assets”
C:\isaac_ws\src\IsaacLab_isaac_sim\kit\python\kit.exe: No module named pip
There was an error running python.
“C:\isaac_ws\src\IsaacLab\source\extensions\omni.isaac.lab_tasks”
module: “C:\isaac_ws\src\IsaacLab\source\extensions\omni.isaac.lab_tasks”
C:\isaac_ws\src\IsaacLab_isaac_sim\kit\python\kit.exe: No module named pip
There was an error running python.
[INFO] Installing extra requirements such as learning frameworks…
[INFO] Installing all rl-frameworks.
C:\isaac_ws\src\IsaacLab_isaac_sim\kit\python\kit.exe: No module named pip
There was an error running python.
[INFO] Setting up vscode settings…

Then tried to verify installation:

C:\isaac_ws\src\IsaacLab>isaaclab.bat -p source\standalone\tutorials\00_sim\create_empty.py
[INFO] Using python from: C:\isaac_ws\src\IsaacLab\_isaac_sim\python.bat
Traceback (most recent call last):
File “C:\isaac_ws\src\IsaacLab\source\standalone\tutorials\00_sim\create_empty.py”, line 20, in
from omni.isaac.lab.app import AppLauncher
ModuleNotFoundError: No module named ‘omni.isaac.lab’
There was an error running python.

So, that was a no go.
I am not sure how to proceed.
Any ideas? Any help would be appreciated, thanks in advance.
Jay