Skip to content

Commit 824a1d9

Browse files
authored
Update 2_isaac_installation.md
1 parent 91271bf commit 824a1d9

1 file changed

Lines changed: 56 additions & 29 deletions

File tree

content/learning-paths/laptops-and-desktops/dgx_spark_isaac_robotics/2_isaac_installation.md

Lines changed: 56 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,19 @@ layout: learningpathall
88

99
## Set up your development environment
1010

11-
Before running robotic simulations and reinforcement learning tasks, you need to build Isaac Sim and Isaac Lab from source on your DGX Spark system. This section walks you through verifying your system, installing dependencies, building Isaac Sim, and then setting up Isaac Lab on top of it.
11+
Before running robotic simulations and reinforcement learning workloads, you need to prepare your DGX Spark development environment and install the dependencies required for Isaac Sim and Isaac Lab.
1212

13-
The build process takes approximately 15-20 minutes on the Grace CPU and requires around 50 GB of available disk space.
13+
In this section you will:
14+
* Verify the DGX Spark system configuration
15+
* Install required build dependencies
16+
* Build and configure Isaac Sim
17+
* Set up Isaac Lab on top of the Isaac Sim environment
18+
19+
The full setup typically takes 15–20 minutes on a DGX Spark system and requires approximately 50 GB of available disk space.
1420

1521
## Step 1: Verify your system
1622

17-
Start by confirming that your DGX Spark system has the required hardware and software configuration.
23+
Begin by confirming that the DGX Spark system has the expected hardware and software configuration.
1824

1925
Check the CPU architecture:
2026

@@ -31,8 +37,9 @@ Architecture: aarch64
3137
CPU(s): 20
3238
On-line CPU(s) list: 0-19
3339
```
40+
The Architecture field should report aarch64, indicating that the system is running on Arm.
3441

35-
Verify the Blackwell GPU is recognized:
42+
Check that the Blackwell GPU is detected by the NVIDIA driver:
3643

3744
```bash
3845
nvidia-smi
@@ -49,6 +56,7 @@ You will see output similar to:
4956
| 0 NVIDIA GB10 On | 0000000F:01:00.0 Off | N/A |
5057
+-----------------------------------------+------------------------+----------------------+
5158
```
59+
The GPU name should appear as NVIDIA GB10, confirming that the Grace–Blackwell GPU is available.
5260

5361
Confirm the CUDA toolkit is installed:
5462

@@ -68,115 +76,135 @@ Isaac Sim requires GCC/G++ 11, Git LFS, and CUDA 13.0 or later. If any of these
6876

6977
## Step 2: Install GCC 11 and Git LFS
7078

71-
Isaac Sim requires GCC/G++ version 11 for compilation. Install it and set it as the default compiler:
79+
Isaac Sim requires GCC/G++ version 11 when building components from source. Install the required compiler version and configure it as the system default.
80+
Update the package index and install the GCC 11 toolchain:
7281

7382
```bash
7483
sudo apt update && sudo apt install -y gcc-11 g++-11
84+
```
85+
Register GCC 11 as the default compiler using update-alternatives. This allows multiple compiler versions to coexist while prioritizing GCC 11 for builds:
86+
```bash
7587
sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-11 200
7688
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-11 200
7789
```
7890

79-
Install Git LFS, which is needed to pull large binary assets from the Isaac Sim repository:
91+
Next, install Git LFS (Large File Storage). Isaac Sim repositories use Git LFS to manage large binary assets such as models and simulation data.
8092

8193
```bash
8294
sudo apt install -y git-lfs
8395
```
8496

85-
Verify both installations:
97+
After installation, verify that the compiler and Git LFS are available:
8698

8799
```bash
88100
gcc --version
89101
g++ --version
90102
git lfs version
91103
```
92104

93-
The GCC output should show version 11.x. Git LFS should report a version number confirming it is installed.
105+
The gcc and g++ commands should report version 11.x, and git lfs version should display the installed Git LFS version.
94106

95107
## Step 3: Clone and build Isaac Sim
96108

97-
Clone the Isaac Sim repository from GitHub. The `--depth=1` flag creates a shallow clone to reduce download time, and `--recursive` fetches all submodules:
109+
Next, download the Isaac Sim source repository and its required assets.
98110

111+
Start by cloning the repository. The --depth=1 option performs a shallow clone to reduce download size, and --recursive ensures all required submodules are fetched.
99112
```bash
100113
cd ~
101114
git clone --depth=1 --recursive https://github.com/isaac-sim/IsaacSim
102115
cd IsaacSim
116+
```
117+
Isaac Sim stores large simulation assets (such as USD environments, textures, and prebuilt components) using Git Large File Storage (LFS). Initialize Git LFS and download the required assets:
118+
```bash
103119
git lfs install
104120
git lfs pull
105121
```
106122

107123
{{% notice Note %}}
108-
The Git LFS pull downloads several gigabytes of simulation assets (USD files, textures, and pre-built libraries). Ensure you have a stable network connection.
124+
The Git LFS download retrieves several gigabytes of simulation assets. Ensure you have a stable internet connection and sufficient disk space before running this step.
109125
{{% /notice %}}
110126

111-
Build Isaac Sim by running the build script. This compiles the simulation engine and all its components:
127+
Once the repository and assets are downloaded, build Isaac Sim using the provided build script:
112128

113129
```bash
114130
./build.sh
115131
```
132+
By default, the build uses all available CPU cores on the Grace processor. On DGX Spark, compilation typically takes 10-15 minutes.
116133

117-
The build uses all available CPU cores on the Grace processor. On DGX Spark, compilation typically takes 10-15 minutes.
118-
119-
When the build succeeds, you will see output similar to:
134+
When the build finishes successfully, you will see output similar to:
120135

121136
```output
122137
BUILD (RELEASE) SUCCEEDED (Took 674.39 seconds)
123138
```
124139

125140
## Step 4: Set Isaac Sim environment variables
126141

127-
After the build completes, configure your shell to recognize the Isaac Sim installation. Run the following commands from inside the `IsaacSim` directory:
142+
After the build completes, configure environment variables so that your shell can locate the Isaac Sim binaries and Python runtime.
128143

144+
Navigate to the IsaacSim directory if you are not already there, then export the following variables:
129145
```bash
130146
export ISAACSIM_PATH="${PWD}/_build/linux-aarch64/release"
131147
export ISAACSIM_PYTHON_EXE="${ISAACSIM_PATH}/python.sh"
132148
```
133149

134-
The table below explains each variable:
150+
These variables are used by Isaac Lab and other tools to locate the Isaac Sim runtime.
135151

136152
| **Variable** | **Purpose** |
137153
|--------------|-------------|
138154
| `ISAACSIM_PATH` | Points to the compiled Isaac Sim binaries and libraries under the `_build` directory |
139155
| `ISAACSIM_PYTHON_EXE` | References the Python wrapper script that runs Python with Isaac Sim's dependencies preloaded |
140156

141157
{{% notice Tip %}}
142-
Add these `export` lines to your `~/.bashrc` file so they persist across terminal sessions:
143-
158+
To make these environment variables persist across terminal sessions, add them to your shell configuration file.
159+
Run the following commands:
144160
```bash
145161
echo 'export ISAACSIM_PATH="$HOME/IsaacSim/_build/linux-aarch64/release"' >> ~/.bashrc
146162
echo 'export ISAACSIM_PYTHON_EXE="${ISAACSIM_PATH}/python.sh"' >> ~/.bashrc
147163
source ~/.bashrc
148164
```
165+
After this step, the variables will be available automatically whenever you open a new terminal.
166+
149167
{{% /notice %}}
150168

151169
## Step 5: Validate the Isaac Sim build
152170

153-
Launch Isaac Sim to verify the build was successful. The `LD_PRELOAD` setting resolves a library compatibility issue on aarch64:
171+
Launch Isaac Sim to verify the build was successful. On some aarch64 systems, Isaac Sim may require preloading the GNU OpenMP runtime (libgomp) to avoid library compatibility issues. Setting the LD_PRELOAD environment variable ensures the correct library is loaded before Isaac Sim starts.
154172

173+
Run the following command to launch Isaac Sim:
155174
```bash
156175
export LD_PRELOAD="$LD_PRELOAD:/lib/aarch64-linux-gnu/libgomp.so.1"
157176
${ISAACSIM_PATH}/isaac-sim.sh
158177
```
159178

160-
If the build is correct, Isaac Sim opens its viewer window (or starts in headless mode if no display is available). You should see initialization messages confirming that the Blackwell GPU is detected and the physics engine is ready.
179+
If the installation is correct, Isaac Sim opens its viewer window (or starts in headless mode if no display is available). During startup, the console output should report initialization of the Blackwell GPU and the physics simulation engine.
180+
181+
Once you confirm that Isaac Sim starts successfully, stop the application by pressing:
182+
`Ctrl + C`
161183

162-
Press `Ctrl+C` in the terminal to close Isaac Sim after verifying it starts successfully.
184+
This returns you to the terminal and confirms that the build and runtime environment are functioning correctly.
163185

164186
## Step 6: Clone and install Isaac Lab
165187

166-
With Isaac Sim successfully built and validated, you can now set up Isaac Lab to enable RL training workflows. Clone the repository into your home directory:
188+
After confirming that Isaac Sim runs correctly, you can install Isaac Lab, which provides the reinforcement learning environments and training pipelines used in this learning path.
189+
Start by cloning the Isaac Lab repository into your home directory:
167190

168191
```bash
169192
cd ~
170193
git clone --recursive https://github.com/isaac-sim/IsaacLab
171194
cd IsaacLab
172195
```
196+
Isaac Lab expects to locate an Isaac Sim installation in a directory named `_isaac_sim` inside the repository. Instead of copying files, create a symbolic link pointing to the Isaac Sim build directory that you configured earlier.
173197

174-
Create a symbolic link so Isaac Lab can find your Isaac Sim installation:
198+
First confirm that the ISAACSIM_PATH variable is set:
175199

176200
```bash
177201
echo "ISAACSIM_PATH=$ISAACSIM_PATH"
202+
```
203+
Then create the symbolic link
204+
```bash
178205
ln -sfn "${ISAACSIM_PATH}" "${PWD}/_isaac_sim"
179206
```
207+
This links the Isaac Lab repository to the Isaac Sim installation that was built in the previous steps.
180208

181209
Verify the symbolic link is correct:
182210

@@ -186,7 +214,7 @@ ls -l "${PWD}/_isaac_sim/python.sh"
186214

187215
You should see the symlink pointing to your Isaac Sim build directory.
188216

189-
Install Isaac Lab and all its dependencies:
217+
Next, install Isaac Lab and its Python dependencies:
190218

191219
```bash
192220
./isaaclab.sh --install
@@ -196,14 +224,13 @@ This command installs the Isaac Lab Python packages, RL libraries (RSL-RL, rl_ga
196224

197225
## Step 7: Validate the Isaac Lab installation
198226

199-
Verify that Isaac Lab is installed correctly by listing the available RL environments:
227+
Confirm that Isaac Lab is installed correctly by listing the available RL environments:
200228

201229
```bash
202230
export LD_PRELOAD="$LD_PRELOAD:/lib/aarch64-linux-gnu/libgomp.so.1"
203231
./isaaclab.sh -p scripts/environments/list_envs.py
204232
```
205-
206-
You should see a list of available environments, including entries such as:
233+
If the installation is successful, the command prints a list of available environments. The output will include entries similar to:
207234

208235
```output
209236
Isaac-Cartpole-v0
@@ -225,9 +252,9 @@ In this section you have:
225252

226253
- Verified your DGX Spark system has the required Grace CPU, Blackwell GPU, and CUDA 13 environment
227254
- Installed GCC 11 and Git LFS as build prerequisites
228-
- Cloned and built Isaac Sim from source, producing aarch64-optimized binaries for the Grace-Blackwell platform
255+
- Cloned and built Isaac Sim, producing binaries for the aarch64 GraceBlackwell platform
229256
- Configured environment variables so Isaac Lab can locate the Isaac Sim installation
230257
- Cloned and installed Isaac Lab with all RL library dependencies
231258
- Validated both installations by launching Isaac Sim and listing available environments
232259

233-
Your development environment is now fully configured for robot simulation and RL workflows. In the next module, you will run your first robot simulation and begin interacting with Isaac Sim through Python scripts.
260+
Your development environment is now fully configured for robot simulation and RL workflows. In the next section, you will run your first robot simulation and begin interacting with Isaac Sim through Python scripts.

0 commit comments

Comments
 (0)