holoscan-install-source

ソースから Holoscan 5.x をビルドする

ソースと前提条件を選択する

未公開の Early Access 機能、SDK の変更、カスタムコンポーネント、またはデバッグビルドには、ソースを使用します。このワークフローでは、Ubuntu 24.04 と CUDA 13 を使用するチェックアウトのビルドコンテナを使い、x86_64 または arm64 dGPU を対象とします。Linux、ディスク容量、GPU／ドライバー、Git、Docker、buildx、NVIDIA Container Toolkit が利用可能か確認します。開始する前に、コンテナのダウンロードとビルドにかかるコストを説明します。

リリースノートまたはユーザーが指定した開発ブランチから、明示的な 5.x ソース ref を選択します。既存のチェックアウトを再利用する前に状態を確認し、そのブランチとローカルの変更を維持します。指定された ref を完全なコミットに解決します。リモートブランチの場合は、対象のリモートの ref を使用し、必要に応じてその ref をフェッチします。既存リポジトリのルートから、ビルド前に HEAD と解決した ref を比較します。

git status --short
git rev-parse HEAD
git rev-parse --verify "${SDK_REF}^{commit}"

SDK_REF は、選択したタグ、コミット、またはリモート名付きブランチを示す必要があります。ref を解決できない場合、またはコミットが異なる場合は、停止して不一致を報告します。既存のブランチと作業ツリーを維持し、指定された ref での別のチェックアウトを提案します。HEAD が一致する場合でもローカルの変更を報告し、ユーザーが変更済みチェックアウトのビルドを希望している場合はその変更を保持します。

新しいパブリックチェックアウトの場合：

# SDK_REF is a confirmed published 5.x tag or development branch.
git ls-remote --heads --tags https://github.com/nvidia-holoscan/holoscan-sdk.git
mkdir -p ~/holoscan
git clone --branch "$SDK_REF" https://github.com/nvidia-holoscan/holoscan-sdk.git ~/holoscan/holoscan-sdk-5x
cd ~/holoscan/holoscan-sdk-5x
cat VERSION
./run --help
./run build --help

VERSION が 5.x であることを確認します。このチェックアウトの AGENTS.md、DEVELOP.md、docs/sdk_installation.mdx を読みます。これらは未リリースのブランチに適用されます。内部チェックアウトでは、エクスポートされたソースルートは VERSION と run を含むディレクトリです。そのディレクトリからコマンドを実行します。リポジトリのデフォルトブランチや、4.x の例が要求された 5.x ソースだと決めつけてはいけません。

ビルド

./run check_system_deps
./run build --dryrun
./run build

ラッパーがビルド、設定、コンパイル、インストールを行います。デフォルトでは、Python、サンプル、オペレーターのテスト、オプションのモジュールが有効になります。便利なオプションは次のとおりです。

オプション	意味
--type debug / --type rel-debug	デバッグ／デバッグ情報付きリリース
--arch arm64	ARM64 ターゲット。チェックアウトのクロスコンパイル前提条件を確認してください
--buildpath build-custom	ビルドディレクトリを明示的に指定
--installprefix install-custom	インストール先を明示的に指定
--build-python false	C++ のみのビルド
--config "-DHOLOSCAN_BUILD_VISION=OFF"	チェックアウトが対応している場合、オプションのコンポーネントを無効化

ビルド、ディレクトリの照会、起動では、同じターゲット選択を使用します。標準のディレクトリ構成は build-<arch> と install-<arch> です。4.x の build-cu<N>-<arch> という命名ではなく、./run get_build_dir と ./run get_install_dir を使用してください。カスタムパスは明示的に指定する必要があります。設定が古い場合は --reconfigure を指定して開始します。クリーンアップコマンドを使用する前に、そのコマンドで削除される内容を確認してください。

検証

デフォルトのビルドディレクトリの場合：

./run test --name 'EXAMPLE_CPP_HELLO_WORLD_TEST|EXAMPLE_CPP_HELLO_CORE_TEST|EXAMPLE_PYTHON_FIRST_PIPELINE_TEST'

選択したテストが検出され実行されたことを確認します。テスト数がゼロでも成功と見なしてはいけません。C++ のみのビルドでは Python のケースは省略されます。カスタムディレクトリの場合：

./run launch build-custom --run-cmd "ctest -N"
./run launch build-custom --run-cmd "ctest -R 'EXAMPLE_CPP_HELLO_WORLD_TEST|EXAMPLE_CPP_HELLO_CORE_TEST|EXAMPLE_PYTHON_FIRST_PIPELINE_TEST' --output-on-failure"

これらは、あいさつ、実行範囲を制限した C++ Core の実行、5.x の Python パイプラインを対象とします。選択したコンポーネントに応じて、追加のモジュール／GPU テストを実行し、未テストの項目を明示してください。クロスコンパイルは、ターゲットアーキテクチャでの実行を検証するものではありません。

find_package(holoscan) と holoscan::core を使用するコンシューマープロジェクトでは、絶対パスのインストール先を CMAKE_PREFIX_PATH として使用します。ソースのコミット、ビルドオプション、ビルド／インストールディレクトリ、テスト結果を報告します。GPU パススルーまたは buildx の失敗については、失敗したコマンドと診断出力を報告し、チェックアウトのチェックで特定された前提条件を解決します。原因が不明のままの場合は、無期限に再試行したり無関係なシステム設定を変更したりせず、ビルドを開始する前に停止して、不足しているホスト情報を求めてください。