OpenSourceBrain 翻訳ページ

OpenSourceBrain Documentation: OSBv1 に関するチュートリアルの作成

このページは外部資料の日本語訳です。原文の見出し順と本文順を保ち、コード・URL・出典表記はできるだけ原形のまま残しています。

種別

翻訳資料

更新日

2026-05-20

対象

外部資料を日本語で原文順に読みたい読者

目安

原文量に依存

確認メモ

機械翻訳をベースにした日本語訳です。実装手順や引用は必ず原典も確認してください。

出典とライセンス

原典: https://github.com/OpenSourceBrain/Documentation/blob/main/source/OSBv1/Creating_Tutorials.md

ライセンス: CC BY 4.0。このページは日本語翻訳であり、変更点は翻訳とサイト内整形です。

OSBv1 に関するチュートリアルの作成

ユーザーには、OSB プロジェクトを新しいチュートリアルに変えることをお勧めします。

チュートリアル リポジトリの例は ここ にあります。以下でこの例を参照します。

まず、チュートリアルに使用するモデルを開きます。チュートリアルを構築するには、デフォルト セッションの構成とメインのステップバイステップ ガイドの作成という 2 つの主要なコンポーネントがあります。

デフォルトセッションの構成

ウィジェットを開いたり、人口の再着色、ズームやモデルの位置など、プロジェクトの状態に加えた変更はすべて保存して、チュートリアルのデフォルトの作業環境として再利用できます。 たとえば、Blue Brain Project ショーケースセッション を見てください。すぐに、モデルの説明、チュートリアル、情報ボックスという 3 つのポップアップ ウィジェットが表示されます。これは、元のプロジェクトでこれらのウィンドウを作成するだけで実現できます (つまり、[モデルの説明] をクリックし、コンソールを使用して ポップアップウィジェットを追加する を実行し、右上のツールバーの ボタンを使用してプロジェクトをダウンロードします)。

project.zip ファイルには、xmi ファイル、json ファイル、js ファイル、および実行した実験の結果が含まれています。 zip の内容を リポジトリのサブディレクトリ に配置します。その後、OSB 上のプロジェクトのモデル ページに json ファイルへのリンクが表示されます。

ステップバイステップのチュートリアル コンポーネントを含める場合は、デフォルトのセッション状態の一部としてチュートリアル ウィジェットが開いていることを確認してください。左側のツールバーにある本のアイコンを押すと、チュートリアル ウィジェットを開くことができます。

ステップバイステップのガイドを作成する

チュートリアルの主なコンポーネントは、ステップごとに 1 つのプレーン HTML ファイルと、それらを結び付ける json ファイルです。例については、ここ を参照してください。 インタラクティブな側面を作成するには、quickExperiment JavaScript 関数を使用して、受講者が設定したパラメーターを使用して実験を追加できます。例については、ここ を参照してください。 json ファイルでは、name (チュートリアル タイトル)、チュートリアル ウィジェットのデフォルトの height および width、各ステップの HTML ファイルのパスのリストを指定する必要があります。例については、ここ を参照してください。

最後に、上記の手順 (デフォルト セッションの構成) でダウンロードした json ファイルを編集して、チュートリアル ウィジェットにチュートリアルを追加する必要があります。編集する前に、フォーマッタ を通じてこのファイルを実行すると役立つ場合があります。チュートリアル ウィジェットのデータ フィールドに、上で作成した json ファイルを指す URL を追加します (例については、ここ を参照)。 componentSpecific の下の activeTutorial フィールドを、最初に表示したいチュートリアルのタイトルに変更することもできます。受講者は、チュートリアル ウィジェットの左上隅にある本のアイコンを使用してチュートリアルを切り替えることができます。

既存のチュートリアル

既存のチュートリアル ここ をご覧ください。シナプス統合チュートリアルはまだ開発中です。

サポート

チュートリアルの準備のどの段階でも、ご連絡ください