File size: 4,324 Bytes
406662d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | Installation using Isaac Lab Pip Packages
=========================================
From Isaac Lab 2.0, pip packages are provided to install both Isaac Sim and Isaac Lab extensions from pip.
Note that this installation process is only recommended for advanced users working on additional extension projects
that are built on top of Isaac Lab. Isaac Lab pip packages **does not** include any standalone python scripts for
training, inferencing, or running standalone workflows such as demos and examples. Therefore, users are required
to define their own runner scripts when installing Isaac Lab from pip.
To learn about how to set up your own project on top of Isaac Lab, please see :ref:`template-generator`.
.. note::
Currently, we only provide pip packages for every major release of Isaac Lab.
For example, we provide the pip package for release 2.1.0 and 2.2.0, but not 2.1.1.
In the future, we will provide pip packages for every minor release of Isaac Lab.
.. include:: include/pip_python_virtual_env.rst
Installing dependencies
~~~~~~~~~~~~~~~~~~~~~~~
.. note::
In case you used UV to create your virtual environment, please replace ``pip`` with ``uv pip``
in the following commands.
- Install a CUDA-enabled PyTorch 2.7.0 build for CUDA 12.8 that matches your system architecture:
.. tab-set::
:sync-group: pip-platform
.. tab-item:: :icon:`fa-brands fa-linux` Linux (x86_64)
:sync: linux-x86_64
.. code-block:: bash
pip install -U torch==2.7.0 torchvision==0.22.0 --index-url https://download.pytorch.org/whl/cu128
.. tab-item:: :icon:`fa-brands fa-windows` Windows (x86_64)
:sync: windows-x86_64
.. code-block:: bash
pip install -U torch==2.7.0 torchvision==0.22.0 --index-url https://download.pytorch.org/whl/cu128
.. tab-item:: :icon:`fa-brands fa-linux` Linux (aarch64)
:sync: linux-aarch64
.. code-block:: bash
pip install -U torch==2.9.0 torchvision==0.24.0 --index-url https://download.pytorch.org/whl/cu130
.. note::
After installing Isaac Lab on aarch64, you may encounter warnings such as:
.. code-block:: none
ERROR: ld.so: object '...torch.libs/libgomp-XXXX.so.1.0.0' cannot be preloaded: ignored.
This occurs when both the system and PyTorch ``libgomp`` (GNU OpenMP) libraries are preloaded.
Isaac Sim expects the **system** OpenMP runtime, while PyTorch sometimes bundles its own.
To fix this, unset any existing ``LD_PRELOAD`` and set it to use the system library only:
.. code-block:: bash
unset LD_PRELOAD
export LD_PRELOAD="$LD_PRELOAD:/lib/aarch64-linux-gnu/libgomp.so.1"
This ensures the correct ``libgomp`` library is preloaded for both Isaac Sim and Isaac Lab,
removing the preload warnings during runtime.
- Install the Isaac Lab packages along with Isaac Sim:
.. code-block:: none
pip install isaaclab[isaacsim,all]==2.3.0 --extra-index-url https://pypi.nvidia.com
- If you want to use ``rl_games`` for training and inferencing, install
its Python 3.11 enabled fork:
.. code-block:: none
pip install git+https://github.com/isaac-sim/rl_games.git@python3.11
.. include:: include/pip_verify_isaacsim.rst
Running Isaac Lab Scripts
~~~~~~~~~~~~~~~~~~~~~~~~~
By following the above scripts, your Python environment should now have access to all of the Isaac Lab extensions.
To run a user-defined script for Isaac Lab, simply run
.. code:: bash
python my_awesome_script.py
Generating VS Code Settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Due to the structure resulting from the installation, VS Code IntelliSense (code completion, parameter info
and member lists, etc.) will not work by default. To set it up (define the search paths for import resolution,
the path to the default Python interpreter, and other settings), for a given workspace folder,
run the following command:
.. code-block:: bash
python -m isaaclab --generate-vscode-settings
.. warning::
The command will generate a ``.vscode/settings.json`` file in the workspace folder.
If the file already exists, it will be overwritten (a confirmation prompt will be shown first).
|