ソースから Dynamo をビルドする

Dynamo のソースは、クローンを作成して他のユーザに提供するために、GitHub でホストされています。この章では、git を使用してリポジトリをクローン作成する方法、Visual Studio を使用してソースファイルをコンパイルする方法、ローカルビルドを実行およびデバッグする方法、および GitHub から新しい変更を取得する方法について説明します。

GitHub で Dynamo リポジトリを検索する

GitHub は、利用者間の変更を追跡し、作業を調整するためのバージョン管理システムである git に基づくホストサービスです。git は、Dynamo のソースファイルをダウンロードして、いくつかのコマンドでそれらを更新するために活用できるツールです。この方法を使用すると、更新のたびにソースファイルをダウンロードし、手動で置き換えるといった面倒な作業を回避できます。git バージョン管理システムは、ローカルおよびリモート間のコードリポジトリの違いを追跡します。

Dynamo のソースは、次のリポジトリの DynamoDS GitHub でホストされます。 https://github.com/DynamoDS/Dynamo

Dynamo ソースファイルです。
リポジトリ全体をクローン作成またはダウンロード
他の DynamoDS リポジトリを表示
Dynamo のソースファイル
git 固有ファイル

git を使用して Dynamo リポジトリをプルする

リポジトリをクローン作成する前に、git をインストールする必要があります。インストール手順、および GitHub ユーザ名と電子メールの設定方法については、この簡易ガイドに従ってください。この例では、コマンドラインで git を実行します。このガイドでは、Windows を使用することを前提としていますが、Mac または Linux で git を使用して Dynamo ソースをクローン作成することもできます。

クローン作成する Dynamo リポジトリの URL が必要です。これは、リポジトリのページの「クローンまたはダウンロード」ボタンにあります。URL をコピーしてコマンドプロンプトに貼り付けます。

「クローンまたはダウンロード」を選択する
URL をコピーする

git がインストールされていると、Dynamo リポジトリをクローン作成できます。はじめに、コマンドプロンプトを開きます。次に、フォルダの変更コマンド cd を使用して、クローン作成するソースファイルのあるフォルダに移動します。この例では、Github というフォルダを Documents に作成します。

cd C:\Users\username\Documents\GitHub

「username」をユーザ名と置き換えます

次の手順では、git コマンドを実行して、指定した場所に Dynamo リポジトリをクローン作成します。コマンドの URL は、GitHub の「クローンまたはダウンロード」ボタンをクリックして取得します。コマンドターミナルでこのコマンドを実行します。これにより、Dynamo の最新のコードである Dynamoリポジトリのマスターブランチをクローン作成します。このマスターブランチには、最新バージョンの Dynamo コードが含まれます。このブランチは毎日変更されます。

git clone https://github.com/DynamoDS/Dynamo.git

クローン作成操作が正常に完了したことで、git が動作していることを確認できました。ファイルのエクスプローラで、クローン作成したフォルダに移動してソースファイルを表示します。フォルダ構造は、GitHub の Dynamo リポジトリのマスターブランチと同じに見える必要があります。

Dynamo のソースファイル
git ファイル

Visual Studio を使用してリポジトリをビルドする

ソースファイルがローカルマシンにクローン化されたため、Dynamo の実行可能ファイルを構築できるようになりました。これを進めるには、Visual Studio IDE をセットアップし、.NET Framework と DirectX がインストールされていることを確認する必要があります。

完全な機能を備えた無料の IDE (統合開発環境) Microsoft Visual Studio Community 2015 をダウンロードしてインストールします(これ以降のバージョンでも動作する可能性があります)。
Microsoft .NET Framework 4.5 以降をダウンロードしてインストールします
ローカルの Dynamo リポジトリ(Dynamo\tools\install\Extra\DirectX\DXSETUP.exe)から、Microsoft DirectX をインストールします

.NET および DirectX は、すでにインストールされている可能性があります。

インストールがすべて完了したら、Visual Studio を起動して、Dynamo\src にある Dynamo.All.sln ソリューションを開きます。

File > Open > Project/Solution を選択します。
Dynamo リポジトリを参照して src フォルダを開きます。
ソリューションファイル Dynamo.All.sln を選択します。
Open を選択します。

ソリューションを構築する前に、いくつか設定が必要です。まず、Dynamo のデバッグバージョンを構築し、デバッグ中に Visual Studio が詳細情報を収集することで、それを開発に役立てることができます。また、AnyCPU をターゲットにします。

bin フォルダ内のフォルダとして設定されます。
このサンプルでは、ソリューション設定として Debug を選択します
ソリューションプラットフォームを Any CPU に設定します

プロジェクトを開いて、ソリューションを構築できます。このプロセスでは、実行可能な DynamoSandbox.exe ファイルを作成します。

プロジェクトをビルドすると、NuGet の依存関係が復元されます。
Build > Build Solution を選択します。
出力ウィンドウで正常にビルドされたことを確認します。次のように表示されます。 ==== Build: 69 succeeded, 0 failed, 0 up-to-date, 0 skipped ====

ローカルビルドを実行する

Dynamo が正常にビルドを完了すると、DynamoSandbox.exe ファイルを含む bin フォルダが Dynamo リポジトリに作成されます。このサンプルでは、デバッグオプションを使用してビルドしているため、実行可能ファイルは bin\AnyCPU\Debug に配置されます。これ実行すると、Dynamo のローカルビルドが開きます。

先ほどビルドした DynamoSandbox の実行可能ファイルです。これを実行して Dynamo を起動します。

これで、Dynamo の開発を始めるための設定はほぼ完了しました。

その他のプラットフォーム(Linux や OS X など)向けに Dynamo を構築する手順については、Wiki ページを参照してください。

Visual Studio を使用してローカルビルドをデバッグする

デバッグは、不具合や問題を特定し、分離、修正するプロセスです。Dynamo がソースから正常に構築されると、Visual Studio のいくつかのツールを使用して、DynamoRevit アドインなど実行中のアプリケーションをデバッグすることができます。ソースコードを分析して問題の原因を特定したり、現在実行中のコードを検討することができます。Visual Studio のコードのデバッグ方法およびナビゲーション方法の詳細については、「Visual Studio ドキュメント」を参照してください。

デバッグ用の 2 つのオプション、スタンドアロンの Dynamo アプリケーション、DynamoSandbox について説明します。

Visual Studio から直接 Dynamo をビルドして起動する
Dynamo の実行中のプロセスに Visual Studio をアタッチする

Visual Studio から Dynamo を起動すると、必要に応じてデバッグセッションごとにソリューションが再構築されるため、ソースに変更を加えた場合は、デバッグ時に反映されます。Dynamo.All.sln ソリューションを開いたまま、ドロップダウンメニューから Debug、AnyCPU、DynamoSandbox を選択し、[Start]をクリックします。これにより、Dynamo が構築され、新しいプロセス(DynamoSandbox.exe)が開始されて、Visual Studio のデバッガがアタッチされます。

Visual Studio から直接アプリケーションを構築して起動します
環境設定を Debug に設定します
プラットフォームを Any CPU に設定します
スタートアッププロジェクトを DynamoSandbox に設定します
デバッグプロセスを開始するには[Start]をクリックします

あるいは、特定のグラフやパッケージが開いている場合の問題をトラブルシューティングするために、すでに実行中の Dynamo プロセスをデバッグすることもできます。そのためには、Visual Studio でプロジェクトのソースファイルを開き、Attach to Process デバッグメニュー項目を使用して実行中の Dynamo プロセスにアタッチします。

実行中のプロセスを Visual Studio にアタッチする
Debug > Attach to Process... を選択します。
DynamoSandbox.exe を選びます。
Attach を選択します。

いずれの場合も、デバッグするプロセスにデバッガをアタッチしています。デバッガを起動する前または後に、コードが実行される直前にプロセスを一時停止させるブレークポイントをコードに設定することができます。デバッグ中にキャッチされていない例外が発生した場合、Visual Studio はソースコード内の発生した場所にジャンプします。これは、単純なクラッシュ、未処理の例外を検出し、アプリケーションの実行フローを理解できる効率的な方法です。

DynamoSandbox のデバッグ中に、Color.ByARGB ノードのコンストラクタにブレークポイントを設定します。このコンストラクタにより、ノードがインスタンス化されたときに Dynamo プロセスが一時停止します。このノードが例外をスローしたり、Dynamo がクラッシュする原因となっている場合は、コンストラクタの各行をステップごとに調べて、問題が発生している場所を特定することができます。
ブレークポイント
現在実行中の関数と以前の関数呼び出しを示すコールスタック

次のセクション「ソースから DynamoRevit をビルドする」では、デバッグの特定のサンプルについて説明し、ブレークポイントの設定、コードのステップ実行、コールスタックの読み込み方法について説明します。