Install Holoscan Software

This section is intended to help you use the NVIDIA SDK Manager GUI to configure your development environment successfully.

To download and install Holoscan SDK, first prepare your development environment using SDK Manager.

Holoscan Version

Supported Target Hardware

Set Up Using SDK Manager

Download Holoscan SDK

For Holoscan v1.0EA or higher

NVIDIA IGX Orin Developer Kit (P3701-002) [HoloPack 2.x SDK]

In SDK Manager STEP 1: #. Select Holoscan under Product Category. #. Select HoloPack 2.1 under SDK version. #. Select Holoscan SDK under Additional SDK.

Using SDK Manager

For Holoscan v0.3 or higher

NVIDIA IGX Orin Developer Kit (P3701-002) [HoloPack 2.x SDK]

Clara AGX Developer Kit (E3904-0000) [HoloPack 1.x SDK]

In SDK Manager STEP 1:

  1. Select Holoscan under Product Category.

  2. Select HoloPack 1.2 or HoloPack 2.0 under SDK Version.

See info: Install the Holoscan SDK

For Holoscan v0.2

Jetson AGX Xavier (P2888-0002 or P2888-0004)

Clara AGX Developer Kit (E3904-0000)

In SDK Manager STEP 1:

  1. Select Jetson under Product Category.

  2. Select JetPack 5.0 HP under SDK Version.

See info: Install the Holoscan SDK

For Holoscan v0.1

Jetson AGX Xavier (P2888-0002 or P2888-0004)

In SDK Manager STEP 1:

  1. Select Jetson under Product Category.

  2. Select JetPack 4.5.1 under SDK Version.

  3. Select NVIDIA Holoscan as the additional SDK.

Follow the steps to completion.

N/A

Step 1: Set Up the Development Environment

  1. From the Step 01 Development Environment window, select the following:

    • From the Product Category panel, select Jetson or Holoscan (for NVIDIA Holoscan v0.3 or higher).

    • From the System Configuration panel, select the host machine and target hardware.

      For the Holoscan SDK, Jetson AGX Xavier modules, the Clara AGX Developer Kit and IGX Orin Developer Kit are the only hardware supported.

      ../_images/hw-dropdown-igx-orin.png

      If a Jetson device is connected (or if multiple Jetson devices are connected), SDK Manager will auto-select it in the Target Hardware drop-down list. If your device is not automatically detected, click Refresh. You can hover over the message to display the detailed information of the detected hardware.

    • If an IGX Orin Developer Kit device is connected, choose between the dGPU or the iGPU device you would like to set up.

    • From the SDK Version panel, select the operating system and Holopack software version.

    • If relevant, select any Additional SDKs that you want to install.

    An ellipsis (…) in the bottom right corner of a category box indicates that more than one option is available. Click on the ellipsis to show a drop-down menu of available options.

    ../_images/holoscan-step1.png

    Note

    Your display may differ from the one shown here. The information in this screen is populated from your NVIDIA user account access and permissions. If you don’t see your product category in the available selections, verify that your NVIDIA account is registered to the required programs.

  2. Click Continue to proceed to the next step.

Step 2: Review Components and Accept Licenses

  1. From Step 02 Details and License, you can expand the host components and target components panels to review the components that will be installed on your system.

  2. To review the licenses, click on the license agreements hyperlink at the bottom of the page.

  3. Enable the checkbox to accept the terms and conditions of the license agreements.

  4. If you want SDK Manager to download all setup files to a location other than the default path, go to the Download & Install Options located at the bottom of the screen, then select the path you want to use.

    ../_images/clara-2-requirements.png

    For more information about the Download & Install Options, refer to Offline Install.

  5. Select Continue to proceed to the next step.

Step 3: Installation

  1. Before the installation begins, SDK Manager prompts you to enter your sudo password.

    ../_images/sdkm-2-sudo-prompt.013.png

  2. The display shows the progress of the download and installation of the software.

    ../_images/holoscan-step3-install.png

    Select Pause / Resume to toggle the download and installation process.

  3. At the top, you can toggle between the Details and Terminal tabs. The Terminal tab displays detailed information about the download and installation, with any errors highlighted.

  4. On the Terminal tab, you can use the Filter text field to filter and search for specific information.

  5. SDK Manager opens a dialog when it is ready to flash your target device. A prompt provides instructions for preparing your device to get it ready for flashing.

    Note

    The instructions in the flashing dialog vary based on your host and target environment settings.

    SDK Manager supports two options to put your Jetson target into Force Recovery Mode:

    • Automatic Setup: Set the target to Force Recovery Mode via remote command. This requires the device to be flashed and currently running. Please follow the instructions in the flashing dialog.

    ../_images/holoscan-step3-flash-igx-automatic.png

  • Manual Setup: Set the target to Force Recovery Mode via manual operations.

../_images/jetson-flash-manual.png

You can also choose whether to pre-configure the OEM configuration.

  • Pre-Config: SDK Manager will flash the target with the predefined configuration, and there is no need to complete the System Configuration Wizard after flashing.

  • Runtime: No default configuration is set on the target, and you will need to manually complete the System Configuration Wizard after flashing.

After SDK Manager completes the flashing process, the monitor connected to your Jetson system will show a prompt for initial setup.

  • As part of the initial setup process, select a username and password for the Jetson system.

  • After the initial setup process is complete, the Jetson system boots to the Linux desktop.

  • Enter the same username and password you created during the Jetson configuration into SDK Manager’s post-flash installation dialog.

    ../_images/holoscan-step3-install-components-target.png

SDK Manager will now complete the installation of the software libraries. Skipping this step will not install any SDK components on your target hardware, and will keep a clean operating system on your device.

Step 4: Finalize Setup

  1. From Step 04 Summary Finalization, there is a summary of the components that were installed, along with any warnings or errors that were encountered.

  2. The Export Debug Logs link creates a ZIP file of all log files created during installation. This ZIP file is located in the same folder path where the SDK Manager installer downloaded all components.

    Alternatively, click the menu icon in the top right corner of the window (”⋮”), and choose Export Debug Logs from the drop-down menu in the top-right corner.

    ../_images/sdkm-menu.043.png

  3. Consult the Error Messages for information about any errors you may encounter.

  4. Click Finish and Exit to complete the installation.

To install the NVIDIA Holoscan SDK, beginning with NVIDIA Holoscan SDK v.02, go to the following location:

Repair and Uninstall

To update or uninstall an SDK on your system, launch SDK Manager again.

  1. On Step 1, under the installation step numbers, click the Repair/Uninstall hyperlink.

    ../_images/sdkm-repair-uninstall3.png

  2. The Manage NVIDIA SDKs screen shows what has been installed on your system. You can select whether to repair a broken installation, update an existing SDK, or uninstall an SDK.

    ../_images/holoscan-manage-sdk.png