Unverified Commit ea6ee91d authored by Johnson Sun's avatar Johnson Sun Committed by GitHub

Updates docs on Isaac Sim binary installation path and VSCode integration (#1970)

# Description

- Update suggested Isaac Sim binary installation path
Follows the paths (`~/isaacsim` on Linux, `C:\isaacsim` on Windows)
suggested by Isaac Sim docs:

https://docs.isaacsim.omniverse.nvidia.com/latest/installation/install_workstation.html
- Update docs to emphasize that only Isaac Sim binary installation
supports vscode integration
- Fix minor typos

Fixes: https://github.com/isaac-sim/IsaacLab/issues/1951
parent 8820bdff
.. _setup-vs-code:
Setting up Visual Studio Code
-----------------------------
......@@ -18,6 +20,13 @@ Setting up Visual Studio Code
└── tasks.json
.. attention::
The following instructions on setting up Visual Studio Code only work with
:ref:`Isaac Sim Binaries Installation <isaaclab-binaries-installation>` and not with
:ref:`Pip Installation <isaaclab-pip-installation>`.
To setup the IDE, please follow these instructions:
1. Open the ``IsaacLab`` directory on Visual Studio Code IDE
......
......@@ -29,13 +29,12 @@ To check the minimum system requirements,refer to the documentation
.. note::
We have tested Isaac Lab with Isaac Sim 4.5 release on Ubuntu
22.04LTS with NVIDIA driver 535.129.
22.04 LTS with NVIDIA driver 535.129.
From Isaac Sim 4.5 release, Isaac Sim binaries can be downloaded directly as a zip file.
The below steps assume the Isaac Sim folder was unzipped to the Downloads directory.
The below steps assume the Isaac Sim folder was unzipped to the ``${HOME}/isaacsim`` directory.
On Linux systems, Isaac Sim directory will be named
``${HOME}/Downloads/isaac-sim-standalone@*``, with ``*`` corresponding to the Isaac Sim version.
On Linux systems, Isaac Sim directory will be named ``${HOME}/isaacsim``.
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
......@@ -45,10 +44,9 @@ To check the minimum system requirements,refer to the documentation
We have tested Isaac Lab with Isaac Sim 4.5 release on Windows11 with NVIDIA driver 552.86.
From Isaac Sim 4.5 release, Isaac Sim binaries can be downloaded directly as a zip file.
The below steps assume the Isaac Sim folder was unzipped to the Downloads directory.
The below steps assume the Isaac Sim folder was unzipped to the ``C:/isaacsim`` directory.
On Windows systems, Isaac Sim directory will be named
``%USERPROFILE%/Downloads/isaac-sim-standalone@*``, with ``*`` corresponding to the Isaac Sim version.
On Windows systems, Isaac Sim directory will be named ``C:/isaacsim``.
Verifying the Isaac Sim installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -66,7 +64,7 @@ variables to your terminal for the remaining of the installation instructions:
.. code:: bash
# Isaac Sim root directory
export ISAACSIM_PATH="${HOME}/Downloads/isaac-sim-standalone@4.5.0"
export ISAACSIM_PATH="${HOME}/isaacsim"
# Isaac Sim python executable
export ISAACSIM_PYTHON_EXE="${ISAACSIM_PATH}/python.sh"
......@@ -76,7 +74,7 @@ variables to your terminal for the remaining of the installation instructions:
.. code:: batch
:: Isaac Sim root directory
set ISAACSIM_PATH="%USERPROFILE%/Downloads/isaac-sim-standalone@4.5.0"
set ISAACSIM_PATH="C:/isaacsim"
:: Isaac Sim python executable
set ISAACSIM_PYTHON_EXE="%ISAACSIM_PATH:"=%\python.bat"
......@@ -259,7 +257,7 @@ to index the python modules and look for extensions shipped with Isaac Sim.
cd IsaacLab
# create a symbolic link
ln -s path_to_isaac_sim _isaac_sim
# For example: ln -s ${HOME}/Downloads/isaac-sim-standalone@4.5.0 _isaac_sim
# For example: ln -s ${HOME}/isaacsim _isaac_sim
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
......@@ -270,7 +268,7 @@ to index the python modules and look for extensions shipped with Isaac Sim.
cd IsaacLab
:: create a symbolic link - requires launching Command Prompt with Administrator access
mklink /D _isaac_sim path_to_isaac_sim
:: For example: mklink /D _isaac_sim C:/Users/nvidia/Downloads/isaac-sim-standalone@4.5.0
:: For example: mklink /D _isaac_sim C:/isaacsim
Setting up the conda environment (optional)
......
......@@ -29,6 +29,11 @@ If you encounter any issues, please report them to the
Also, on Windows, it may be necessary to `enable long path <https://pip.pypa.io/warnings/enable-long-paths>`_
support to avoid installation errors due to OS limitations.
.. attention::
If you plan to :ref:`Set up Visual Studio Code <setup-vs-code>` later, we recommend following the
:ref:`Isaac Sim Binaries Installation <isaaclab-binaries-installation>` approach.
.. note::
If you use Conda, we recommend using `Miniconda <https://docs.anaconda.com/miniconda/miniconda-other-installer-links/>`_.
......
......@@ -134,7 +134,7 @@ In this tutorial, we learned how to create and interact with a simple articulati
of an articulation (its root and joint state) and how to apply commands to it. We also saw how to update its
buffers to read the latest state from the simulation.
In addition to this tutorial, we also provide a few other scripts that spawn different robots.These are included
In addition to this tutorial, we also provide a few other scripts that spawn different robots. These are included
in the ``scripts/demos`` directory. You can run these scripts as:
.. code-block:: bash
......
......@@ -56,7 +56,7 @@ when the simulation is played.
As an example on spawning the rigid object prim multiple times, we create its parent Xform prims,
``/World/Origin{i}``, that correspond to different spawn locations. When the regex expression
``/World/Origin*/Cone`` is passed to the :class:`assets.RigidObject` class, it spawns the rigid object prim at
``/World/Origin.*/Cone`` is passed to the :class:`assets.RigidObject` class, it spawns the rigid object prim at
each of the ``/World/Origin{i}`` locations. For instance, if ``/World/Origin1`` and ``/World/Origin2`` are
present in the scene, the rigid object prims are spawned at the locations ``/World/Origin1/Cone`` and
``/World/Origin2/Cone`` respectively.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment