Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/device/cameras/oak.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ subsequent builds are fast.
Prerequisites
~~~~~~~~~~~~~

Complete the :ref:`source-build prerequisites <one-time-setup>` first, then install
the OAK-specific dependencies:
Complete the :doc:`source-build prerequisites </development/build_from_source/index>`
first, then install the OAK-specific dependencies:

.. code-block:: bash

Expand Down
5 changes: 3 additions & 2 deletions docs/source/device/gamepad.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,9 @@ and pass the pad's ``/dev/input/event*`` node into a container.
Build
-----

Linux only. The plugin builds with the default plugin set and fetches SDL3 (zlib license) at
configure time, linking it statically with only its joystick and HIDAPI subsystems:
Linux only. Complete the :doc:`source-build prerequisites </development/build_from_source/index>`
first. The plugin builds with the default plugin set and fetches SDL3 (zlib license) at configure
time, linking it statically with only its joystick and HIDAPI subsystems:

.. code-block:: bash

Expand Down
2 changes: 2 additions & 0 deletions docs/source/device/hand_tracking/haptikos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ Prerequisites
-------------
- **Linux** — x86_64 (tested on Ubuntu 22.04 / 24.04).
- **Haptikos API** for Linux.
- **Source-build prerequisites** — the toolchain and system packages in
:doc:`/development/build_from_source/index`.


Quick Start
Expand Down
3 changes: 2 additions & 1 deletion docs/source/device/hand_tracking/manus.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@ Expected directory layout after placing the SDK:
lib/
libManusSDK.so

Then build from the root:
Then, after the :doc:`source-build prerequisites </development/build_from_source/index>`,
build from the root:

.. code-block:: bash

Expand Down
5 changes: 3 additions & 2 deletions docs/source/device/hand_tracking/wuji_glove.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ Prerequisites
-------------

- **Linux** — x86_64 or aarch64 (tested on Ubuntu 22.04 / 24.04).
- **Source-build prerequisites** — complete :ref:`one-time-setup` before running
``install.sh``.
- **Source-build prerequisites** — the toolchain and system packages in
:doc:`/development/build_from_source/index`, for ``install.sh`` and the manual
CMake build alike.
- **wuji_sdk C SDK v2026.7.14** — the
``wuji-sdk-c-2026.7.14-<arch>-linux-gnu.tar.gz`` GitHub release asset, which
extracts to ``include/wuji_sdk.h`` plus ``lib/libwuji_sdk_c.so`` and its
Expand Down
3 changes: 2 additions & 1 deletion docs/source/device/spatial_controllers/spacemouse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ read-only for all users. No group membership is needed.
Build
-----

Linux only. The plugin builds with the default plugin set:
Linux only. Complete the :doc:`source-build prerequisites </development/build_from_source/index>`
first. The plugin builds with the default plugin set:

.. code-block:: bash

Expand Down
3 changes: 2 additions & 1 deletion docs/source/device/tactile/oglo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ Components
Build
-----

Linux only (BlueZ). The plugin is off by default.
Linux only (BlueZ). The plugin is off by default. Complete the
:doc:`source-build prerequisites </development/build_from_source/index>` first, then:

.. code-block:: bash

Expand Down
6 changes: 4 additions & 2 deletions docs/source/integrations/lerobot/data_collection_real.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,14 +157,16 @@ Then follow the steps for your teleop device:
Isaac Teleop's ``so101_leader`` plugin, which the script launches for you.

#. **Build the so101_leader plugin.** It is part of Isaac Capture's C++ source, not the
``isaaccapture`` pip package, so build it from an Isaac Capture checkout:
``isaaccapture`` pip package. Install the
:doc:`source-build prerequisites </development/build_from_source/index>` first, then
build it from an Isaac Capture checkout:

.. code-block:: bash

cmake -B build && cmake --build build --parallel && cmake --install build

The binary lands at ``install/plugins/so101_leader/so101_leader_plugin``. For details see
:ref:`so101-leader-plugin` and :doc:`/development/build_from_source/index`.
:ref:`so101-leader-plugin`.

#. **Calibrate the leader** so the leader and follower agree on each joint's zero and range.
This reuses the serial SO-101 leader's calibration (stored under ``so_leader/<id>.json``
Expand Down
5 changes: 3 additions & 2 deletions docs/source/integrations/lerobot/data_collection_sim.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,9 @@ Collect Teleop Data
source. If ``./install/plugins/so101_leader/so101_leader_plugin`` does not exist, this
step has not been completed.

Install the :ref:`source-build prerequisites <one-time-setup>` first, including
``clang-format-14`` for the Linux format check. Then clone, configure, build, and install:
Install the :doc:`source-build prerequisites </development/build_from_source/index>`
first, including ``clang-format-14`` for the Linux format check. Then clone, configure,
build, and install:

.. code-block:: bash

Expand Down
7 changes: 5 additions & 2 deletions examples/camera_viz/scripts/_install_deps.sh
Original file line number Diff line number Diff line change
Expand Up @@ -442,9 +442,12 @@ EOF
isaaccapture can be built from this checkout instead:
$REPO_ROOT

That is a full C++ / CUDA / Vulkan build and takes a while. Install the
source-build prerequisites first:
That is a full C++ / CUDA / Vulkan build and takes a while. First install
the source-build prerequisites from the Prerequisites and One time setup
sections of:
$REPO_ROOT/docs/source/development/build_from_source/index.rst
camera_viz needs Televiz (isaaccapture.viz), which is built only when the
Vulkan headers (libvulkan-dev) and the CUDA toolkit are found.
EOF

if ! $BUILD_FROM_SOURCE; then
Expand Down
5 changes: 3 additions & 2 deletions examples/noitom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ set its `--host` and `--port` arguments to the Hybrid Data Server TCP endpoint.

## Build

The Noitom SDK is not vendored in this repository. Build the optional plugin
when you need Noitom support:
The Noitom SDK is not vendored in this repository. Complete the
[source-build prerequisites](https://nvidia.github.io/IsaacCapture/main/development/build_from_source/index.html), then build the
optional plugin when you need Noitom support:

```bash
cmake -B build -DBUILD_PLUGIN_NOITOM_MOCAP=ON
Expand Down
5 changes: 4 additions & 1 deletion examples/oglo_tactile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,12 @@ session, records, and draws the overlay). `oglo_heatmap.py` is the renderer.

1. **System deps**

Complete the [source-build prerequisites](https://nvidia.github.io/IsaacCapture/main/development/build_from_source/index.html)
first, then:

```bash
sudo apt install libdbus-1-dev # BlueZ for the BLE plugin
sudo apt install pkg-config glslang-tools libvulkan-dev # BUILD_VIZ=ON below
sudo apt install libvulkan-dev # BUILD_VIZ=ON below; also needs the CUDA toolkit
pip install pillow numpy # heatmap renderer
pip install cupy-cuda12x # headset overlay GPU upload (match your CUDA)
```
Expand Down
4 changes: 2 additions & 2 deletions examples/oxr/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->

Expand All @@ -9,7 +9,7 @@ Examples demonstrating the modular OpenXR tracking API.

## Prerequisites

1. **Build the core library first:**
1. **Build the core library first**, after the [source-build prerequisites](https://nvidia.github.io/IsaacCapture/main/development/build_from_source/index.html):
```bash
# From project root
cmake -B build
Expand Down
5 changes: 3 additions & 2 deletions examples/oxr/python/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->

Expand All @@ -9,7 +9,8 @@ Python examples demonstrating the OpenXR tracking API using the `isaaccapture` P

## Prerequisites

1. **Build and install the project** (from the project root):
1. **Build and install the project** from the project root, after the
[source-build prerequisites](https://nvidia.github.io/IsaacCapture/main/development/build_from_source/index.html):
```bash
cd ../../..
cmake -B build
Expand Down
2 changes: 1 addition & 1 deletion examples/robot_viz/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Two calibrations, different in kind. `src/viz/robot_twin/cpp/frames.hpp` is a co

## Build

Nothing here is compiled; what has to be built is `isaaccapture` itself.
Nothing here is compiled; what has to be built is `isaaccapture` itself. Complete the [source-build prerequisites](https://nvidia.github.io/IsaacCapture/main/development/build_from_source/index.html) first, including the Televiz ones that `BUILD_VIZ=ON` needs.

```bash
cmake -B build -DBUILD_VIZ=ON
Expand Down
3 changes: 2 additions & 1 deletion examples/vehicle_teleop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ The remote side uses the native Linux steering wheel plugin and Isaac Teleop Ope

## Setup

Build and install Isaac Teleop with examples enabled. From the Isaac Teleop repository root:
Build and install Isaac Teleop with examples enabled, after the [source-build prerequisites](https://nvidia.github.io/IsaacCapture/main/development/build_from_source/index.html).
From the Isaac Teleop repository root:

```bash
cmake -B build -DBUILD_EXAMPLES=ON
Expand Down
2 changes: 2 additions & 0 deletions src/plugins/haptikos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ src/plugins/haptikos/
```
### Build

Complete the [source-build prerequisites](https://nvidia.github.io/IsaacCapture/main/development/build_from_source/index.html) first.

#### Build the plugin

```bash
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/noitom_mocap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ provides it.
## Build

The SDK is fetched from `https://github.com/pnmocap/MocapApi`; it is not checked
into this repository.
into this repository. Complete the [source-build prerequisites](https://nvidia.github.io/IsaacCapture/main/development/build_from_source/index.html)
first.

```bash
cmake -B build -DBUILD_PLUGIN_NOITOM_MOCAP=ON
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/oak/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
# ==============================================================================
# This plugin uses FetchContent for DepthAI and vcpkg for its transitive deps.
#
# Prerequisites:
# Prerequisites, after the shared source-build prerequisites in
# docs/source/development/build_from_source/index.rst:
# 1. Build tools for vcpkg to build libusb (Linux only):
# sudo apt install libudev-dev autoconf automake libtool pkg-config
#
Expand Down
3 changes: 3 additions & 0 deletions src/plugins/oak/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ builds are fast.

### Prerequisites

Complete the [source-build prerequisites](https://nvidia.github.io/IsaacCapture/main/development/build_from_source/index.html)
first, then install the OAK-specific dependencies:

```bash
# Install build tools for vcpkg to build libusb (Linux)
sudo apt install libudev-dev autoconf automake libtool pkg-config
Expand Down
5 changes: 3 additions & 2 deletions src/plugins/oglo_tactile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,11 @@ so packet sizes are never hardcoded (wire spec: the OGLO firmware packed12-v5 pa

## Build

Linux only (BlueZ). Prerequisite:
Linux only (BlueZ). Complete the [source-build prerequisites](https://nvidia.github.io/IsaacCapture/main/development/build_from_source/index.html)
first, then:

```bash
sudo apt install libdbus-1-dev pkg-config
sudo apt install libdbus-1-dev
```

```bash
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/xsens_full_body/USER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ You do **not** need an XR headset.

## 3. Get the plugin binary

If you built Isaac Teleop from source, the binary is already there:
If you built Isaac Teleop from source (see the [source-build prerequisites](https://nvidia.github.io/IsaacCapture/main/development/build_from_source/index.html)),
the binary is already there:

```bash
cmake -B build
Expand Down
Loading