Install and run#

Build the Isaac Sim libraries from an Isaac Sim source checkout. This release does not provide prebuilt library wheels, so the Python and native Software Development Kit (SDK) installation steps use your local build outputs. You do not need to build the Isaac Sim or Kit application.

Choose the path that matches your workflow:

Goal

Path

Use Python APIs.

Install one or more wheels from the wheel output directory.

Build a C or C++ application.

Install the native runtime and development SDK components.

Modify a library.

Build the libraries from a source checkout.

Explore a working workflow.

Use the example runner after building or installing the required distributions.

Prerequisites#

Supported platforms are Linux on x86-64 and aarch64 with glibc 2.35 or newer, and Windows on x86-64. macOS and non-NVIDIA hardware are not supported.

The following toolchain requirements are generated directly from source/libraries/system_requirements.toml:

Requirement

Version

Python

3.12

CMake

3.26 or newer

CMake policy compatibility

Through 4.3

C language standard

C11

C++ language standard

C++17

  • On Linux, install GCC and G++ 11.5.0. Verify both versions with gcc --version and g++ --version.

  • Install Python development headers when you build Python bindings or mixed native/Python examples.

  • Keep all library distributions at version 7.0.0a1. Internal package dependencies use exact versions, so packages from different alpha milestones cannot be mixed.

The library build entry point bootstraps the repository-pinned Pixi release and installs the exact environments recorded in pixi.lock. Private binary dependencies remain isolated in the library Packman manifest. You do not need to install Pixi or run the repository-level Isaac Sim application build first.

Build the libraries#

Run the library build entry point from the repository root.

source/libraries/build.sh -r
.\source\libraries\build.bat -r

Add --test to build and run the complete library test suite.

source/libraries/build.sh -r --test
.\source\libraries\build.bat -r --test

Use --group to select one or more distributions when you create Python wheels. The following command builds every wheel and writes it to an explicit output directory.

source/libraries/build.sh -r --wheel --output-dir _build/libraries/wheels
.\source\libraries\build.bat -r --wheel --output-dir _build/libraries/wheels

Install the Python libraries#

Create a Python environment using the version listed in Prerequisites, then install the distribution you need from the wheel output directory. pip resolves Isaac Sim library dependencies pinned to exact versions from that directory. It resolves external dependencies from the configured package index.

# Linux
python3.12 -m venv .venv
source .venv/bin/activate
python -m pip install --find-links _build/libraries/wheels \
    isaacsim-common==7.0.0a1
# Windows
py -3.12 -m venv .venv
.venv\Scripts\Activate.ps1
python -m pip install --find-links _build\libraries\wheels `
    isaacsim-common==7.0.0a1

Replace isaacsim-common with another distribution name when your application does not use the common library directly. Use hyphens in package installation names. Python imports use dots and underscores, such as isaacsim.common.logging.

Verify the installed distribution version.

python -c "import importlib.metadata; print(importlib.metadata.version('isaacsim-common'))"

The command prints 7.0.0a1.

Install a native SDK#

Each distribution provides separate runtime and development components. Install both components into the same prefix to consume its public headers and CMake package configuration. Replace isaacsim_common with the distribution you need.

cmake --install _cmake_build/isaacsim-libraries-release \
    --prefix _build/libraries/sdk \
    --component isaacsim_common-runtime
cmake --install _cmake_build/isaacsim-libraries-release \
    --prefix _build/libraries/sdk \
    --component isaacsim_common-development
cmake --install _cmake_build/isaacsim-libraries-release `
    --prefix _build/libraries/sdk `
    --component isaacsim_common-runtime
cmake --install _cmake_build/isaacsim-libraries-release `
    --prefix _build/libraries/sdk `
    --component isaacsim_common-development

Set CMAKE_PREFIX_PATH to the installation prefix before configuring a native consumer. Install the runtime and development components for each dependency listed on the library page. CMake component and target identifiers use underscores even though Python package installation names use hyphens.

Build and run examples#

Build the Isaac Sim libraries once, then use source/examples/example.sh on Linux or source\examples\example.bat on Windows from the repository root. The launcher uses the matching developer build, installs runner dependencies including packaging, and makes Pixi available to the runner. Do not invoke source/examples/examples.py directly from your virtual environment.

Run build before run to prepare the example dependencies.

# Build every example.
source/examples/example.sh build

# Build one example.
source/examples/example.sh build hello_world.cpp

# Build and run one example.
source/examples/example.sh run hello_world.python

# Build and test every configured example.
source/examples/example.sh test
# Build every example.
.\source\examples\example.bat build

# Build one example.
.\source\examples\example.bat build hello_world.cpp

# Build and run one example.
.\source\examples\example.bat run hello_world.python

# Build and test every configured example.
.\source\examples\example.bat test

Every generated example page provides its stable ID, requirements, and exact run command. Pass arguments to an example after --.

source/examples/example.sh run <example-id> -- <example-arguments>
.\source\examples\example.bat run <example-id> -- <example-arguments>

Use source/examples/example.sh --help on Linux or source\examples\example.bat --help on Windows to list build configuration options and example selection syntax.

Troubleshoot installation#

If pip reports a version conflict, verify that every library wheel comes from the same wheel output directory and uses 7.0.0a1. Remove wheels from earlier alpha milestones from the environment before reinstalling.

If CMake cannot find a distribution, install both its runtime and development components and add the common SDK installation prefix to CMAKE_PREFIX_PATH.