Integrate in your project
This guide provides instructions to import some of the reusable components from the Isaac OS reference repository in your own repository with CMake.
✨ Agent prompt: Integrate Isaac OS components
While the Isaac OS repository currently serves as a hub for reference applications, some of the components in the repository can be reused for
generic robotic development. CMake’s FetchContent can be used to fetch and build selected components from source.
A package of reusable components named holoscan-robotics is planned for Q1 2027.
Prepare the build environment
Use a development environment with:
- A C++20 compiler.
- CMake 4.0 or newer. On Ubuntu, install it from the Kitware APT repository.
- CUDA 13 toolkit. On x86_64, install CUDA 13.2. JetPack 7 already includes it.
- Holoscan SDK 5.0 prebuilt.
Set
CMAKE_PREFIX_PATHorHoloscan_ROOTto its installation prefix. - The dependencies of the components you select.
- Network access for component dependencies not already installed or cached.
To get these dependencies, you can:
- Reuse the repository’s Dockerfile, or read it and copy what you need into your own image or host.
- Start from an NVIDIA container image on NGC, for example CUDA, TensorRT or Holoscan.
Use the build tooling of your choice. The Isaac OS CLI is for the reference applications in the Isaac OS repository. In your own project, you can:
- Use the Holoscan CLI with your own configuration or wrapper.
- Keep your own tooling. To find what it needs, read the Isaac OS build files, or run
./isaac_oscommands with--dryrunin the Isaac OS repository.
We recommend Ninja and Rapids-sccache to speed up your C++ builds.
Identify components to build
Browse Components to choose an operator or library. Select components in CMake:
- Operators: under operators/.
Select operators by name with the
OP_<name>=ONCMake configuration flag. - Libraries: under common/.
Select registered libraries by name with the
LIB_<name>=ONCMake configuration flag. - Wire message schemas: under messages/. These are always configured, and build when a linked target requires them.
These CMake flags names might differ from the CMake target name(s) built within that directory.
Inspect the CMakeLists.txt file of the component of interest to identify the namespace.
📄 Examples
Setting OP_mock=ON enables the operators/mock/ directory, which defines two
link targets:
isaac::operators::mock::joint_state(concrete targetmock_joint_state_op)isaac::operators::mock::sink(concrete targetmock_sink_op)
After importing Isaac OS, link the target your application uses:
Building my_app also builds that operator and its dependencies. A default build
without --target builds both enabled mock operators.
The example below uses OP_camera_info to select operators/camera_info/ and
links its isaac::operators::camera_info target.
Import the components
Rely on CMake’s FetchContent to fetch, build and configure the Isaac OS components you need in your own CMake project.
The minimal example below shows in the CMakeLists.txt how the feature flags can be passed
to select the components, how the imported CMake target is linked, and how its header is
included in a C++ file:
The function scopes the normal variables, but automatically enabled dependencies remain in the shared CMake cache after their parent component is disabled. Reconfiguring applies your changes; a fresh build directory also resets those cached dependency selections.
The options at the top of the Isaac OS root CMakeLists.txt
configure the build. Some of them have defaults that depend on what the host system
provides. Set them in import_isaac_os() or with -D on the configure command line
to fit your needs.
From that source directory, configuring, building, and running, would be done with:
To use Isaac OS with a coding agent in your project, give your agent the For agents page.