Simulation Model 定義を Altium Vault へリリース
Contents
Related article: シミュレーションモデルをコンポーネント定義へ追加
設計者の面から、vault ベースのコンポーネントは、1 つの entity 内で設計領域のコンポーネントを表すために必要な情報を集めます。そのため、それはコンテナとして考えることができます。領域モデルとパラメータ情報は 'bucket' に保存されます。
vault ベースのコンポーネントは領域モデル自体は含まれず、これらのモデルとリンクします。これらのリンクは、ソースコンポーネント定義として設計側で指定します。そこから、Component Item がリリースされます。このため、vault ベースのコンポーネントを定義、リリースするプロセスを調べる前に、最初に領域モデル自体が作成、リリースされていることを確認する必要があります。
このモジュールは、Simulation Model 定義を vault へリリースするプロセスで扱われます。これは、vault ベースのコンポーネントを作成する時、それを使用できるようにするためです。
Simulation Model の定義
設計側にある SimModel file (*.SimModel) 内の simulation model 定義は、リリース側の Simulation Model Item へマップされます。そのファイルの各リリースにより、モデルデータがそのItem の新しいレビジョンへ保存されます。
最初に、新しい SimModel ファイル (File » New » Library » SimModel File) を作成します。そのファイルは、SimModel エディタでアクティブドキュメントになります。モデル定義とターゲット vault（や Item Revision 自体）へのリンクは、このファイル内から処理されます。
SimModel ファイルで、モデルを定義するために必要な情報は以下です:
- Model Name – この欄を使用してモデル名を指定します。vault へリリースした時、この項目は Simulation Model Item の Comment として使用されます。
これは、参照したモデル、または subcircuit ファイルの名称である必要があります。
MDL ファイルを参照する時、名称はモデル定義の.MODEL 行に表示される必要があります。以下のように定義されているダイオードのモデルを考えてみます:
.MODEL 1N4002 D(IS=2.55E-9 RS=0.042 N=1.75 TT=5.76E-6 CJO=1.85E-11 + VJ=0.75 M=0.333 BV=100 IBV=1E-5 )
モデル名は、ここでは 1N4002 です。この名称は、Model Name 欄へ入力する必要があります。
CKT ファイルを参照する時、名称はモデル定義の .SUBCKT 行に表示される必要があります。以下のように定義されているヒューズのモデルを考えてみます:
.SUBCKT FUSE 1 2 PARAMS: CURRENT=1 RESISTANCE=1m SW1 1 2 3 0 SMOD OFF BNLV 3 0 V=(abs(v(1,2))) .MODEL SMOD SW (VT=\{(CURRENT*RESISTANCE)\} RON=1g ROFF=\{RESISTANCE\}) .ENDS FUSEモデル名は、ここでは です。この名称は、Model Name 欄へ入力する必要があります。FUSE
- Kind – このドロップダウンから、いくつかのモデルカテゴリ（アナログデバイス モデル内蔵の SPICE を含む）を利用できます。
- Sub Kind – このドロップダウンには、選択したカテゴリのモデルタイプがリスト表示されます。
- Spice Prefix – このタイプのモデルに関する必要なプリフィックス。Sub-Kind を
Generic Editorに設定しない限り、自動で選択されます。 - Model File –
.mdl、または.cktファイル（Digital SimCode 定義 (.scbファイルで) へリンクするために使用した中間ファイル.mdlを含む）を使用して定義されたモデル。この欄を使用して必要なファイルを指定します。SIMetrix、または SIMPLIS モデルを使用している場合、.lbファイル（Support for SIMetrix/SIMPLIS Models をご覧ください）を指定します。 - Description – モデルの説明（例えば、その用途）を入力します。vault へリリースした時、この項目は Simulation Model Item の Description として使用されます。
- Netlist Template – XSpice ネットリストへ入力される情報が表示されます。事前に定義されている model kinds、sub-kinds、Netlist Template は読み取り専用です。しかし、これらの項目によって、ネットリストにある情報を十分にコントロールできない場合、テンプレートを定義できます。テンプレートを編集するには、Sub-Kind 欄で
Generic Editorを選択する必要があります（最初に、Kind 欄がGeneralに設定されていることを確認します）。他の model sub-kinds が設定されている場合、General/Generic Editorへ変更して効果的にテンプレートを編集できます。 - Netlist Preview – ネットリストが生成された時、またはシミュレーションが実行された時、XSpice ネットリストファイルへ記述されるテキストが読み取り専用で表示されます。
- Model Preview – 参照した
.mdl、または.cktファイルの内容が読み取り専用で表示されます。 - Parameters – モデルのパラメータ（Model-Level Parameters をご覧ください）。
モデル定義の準備ができたら、モデルと同じ名称でファイルを保存します。
これで、モデル定義をリリースできます。これを行うには、以下のステップが必要です:
- Altium Vault にある Item のレビジョンへモデルをリンクします。Item のタイプが
altium-simulation-modelで、シミュレーションモデル データをリリースするレビジョンがPlanned状態である必要があります。 - モデル定義を Item-Revision へリリースします。
モデルレベルのパラメータ
モデルレベルのパラメータは、直接、SimModel ファイル内で定義できます。ドキュメントの Parameters 領域には、選択したmodel Kind/Sub Kindへ適用できるパラメータが、自動で表示されます。Parameter の値は、以下の 2 つの方法で編集できます:
- その位置で編集 – リスト内のパラメータに関連した Parameter Value 欄をクリックします。そして、必要な値を直接、入力します。
- ダイアログベースの編集 – Parameters 領域の下にある Edit Parameters ボタンをクリックし、SimModel Parameters ダイアログを表示します。選択した model Kind/Sub Kind へ適用できるパラメータが表示されます。必要に応じて、これらの値を編集します。OK をクリックした後、Parameters 領域はこの情報で更新されます。
モデルファイルを Vault へリンク
ターゲット vault や Item Revision 自体へのリンクは、SimModel ファイルに保存されます。リンク情報やそれに関連するコントロールは、ドキュメント画面の右側に表示されます。
Item Revision 欄の右にある Choose ボタンをクリックして、Choose Item ダイアログ（Vaults パネルと同じ）を表示します。ダイアログの左上の欄には、現在、閲覧している vault が表示されます。別の vault を選択するには、vault 名（または、vault 名自体）の左にある 
アイコンをクリックします（vault を管理するためのトップレベルのメニューが表示されます）。このメニューには、現在、接続されている全ての vault が表示されます。
ターゲット vault をアクティブにして、フォルダ階層から素早く必要な Item を選択、またはフォルダや Item を作成できます。選択した Item-Revision（リリースしたモデルデータを受け取る）が Planned 状態であることを確認します。
フォルダタイプ
事前にターゲット vault で Simulation Model Item を作成したか、またはモデルをリンクする時に本来の場所にそれを作成しているかどうかに関係無く、Item を含むフォルダを最初に作成する必要があります。フォルダを作成する時にフォルダのタイプを指定できます。これは、フォルダの内容に関係ありません（シミュレーションモデル定義をリリースすると、常に Simulation Model Item になります）。それは、特定の content に関する vault を閲覧する時、フォルダに保存した内容が何か確認できます。Simulation Model Item 用の container としてフォルダを指定するには、Folder Type を altium-simulation-library として設定します。
Item Naming Scheme
親フォルダの他の重要な面は、それに使用した Item Naming Scheme です。これにより、各 Item に関する固有の ID のフォーマットが定義されます。フォルダタイプ、またはcontent タイプに関する短い形式のコードを利用して、様々なデフォルトのサンプルの scheme を利用できます。デフォルトの naming scheme を使用して、ソフトウェアは、vault 全体と既存 Item の識別子をスキャンし、その scheme に基づいて自動で次の固有 ID を割り当てます。これは、リリースする前に手動で Simulation Model Item を作成する時、時間を節約できます。
また、custom scheme ではフォルダを定義できます。変数の部分は、中括弧で囲います (例えば、SIMMODEL-001-{C000})。
Item ライフサイクル定義とレビジョン割り付け
Simulation Model Item を定義すると、シミュレーションモデル定義はそれにリンクされ、Item に使用するライフサイクル管理のタイプや、そのレビジョンに使用した naming scheme を指定できます。シミュレーションモデル定義が Item の最初のレビジョンへリリースされると、これらの scheme は変更できません。
Item Properties ダイアログで、Lifecycle Definition や Revision Naming Scheme 欄を使用して、必要な scheme を指定します。
リンクの確認
vault にある Simulation Model Item のレビジョンを選択して Choose Item ダイアログで OK をクリックすると、ソースモデル定義とターゲット Item 間がリンクされます。リンクの形跡は、SimModel ファイルに戻って確認できす。リンク情報は、SimModel ファイルに保存されます。そのため、ファイルを保存することを確認します!
リリースの実行
vault へリンクし Item-Revision を設定して、シミュレーションモデル定義を vault へリリースできます。File » Release To <TargetVaultName> コマンドを選択します。データを vault へ追加する準備ができた時、確認ダイアログが表示されます。Yes をクリックして、シミュレーションモデル定義を vault へ移行します。
リリースした後、リンクしたモデル定義の Item に関する情報が SimModel ファイルで更新されます – Revision Details (レビジョンのコメントと説明が表示されます) と Revision State (basic ライフサイクル管理を使用している時、Released と表示されます)。ファイルを保存します。Show in Explorer ボタンをクリックして、Vaults パネルから直接、vault にリリースしたモデルを閲覧できます。
vault に保存したリリースデータは、参照された .mdl、または .ckt ファイルや、.SimModel ファイル内のモデル定義から成ります。モデル化されたデジタルコンポーネントでは、参照されたDigital SimCode .scb ファイルや、中間ファイル .mdl ファイルがあります。また、モデルレベルパラメータはモデル Item のプレビューで表示できます。その内容のプレビューを表示するには、参照したファイルをクリックします。
リリースしたモデルはコンポーネント定義で使用できます。そして、それを参照するリリースした Component Item となり、シミュレーションを行う準備ができます。詳細については、 シミュレーションモデルをコンポーネント定義へ追加 をご覧ください。
SIMetrix/SIMPLIS モデルのサポート
SIMetrix、または SIMPLIS モデルを参照するシミュレーションモデル定義も、Altium Vault へリリースできます。これらのタイプのモデルを使用している時、以下の 2 つの点を覚えておいてください:
- Model Name は、
SIMetrix_、またはSIMPLIS_のプリフィックスを含める必要があります。これにより、別のシミュレータへ指定したモデルを区別することができます。 - Model File 欄は、モデルファイル (
*.lb) を指定する必要があります。そこで、SIMetrix/SIMPLIS モデルは定義されます。
vault に保存されたリリースデータは、参照された .lb ファイルや、.SimModel ファイルのモデル定義から成ります。その他の参照されたモデルファイルや、.lb ファイルの内容は、Simulation Model Item に関するモデルレベル パラメータと一緒に Vaults パネル内で表示できます。
モデル定義の再リリース
vault へリンクしたソース SimModel ファイルや Simulation Model Item と一緒に、そのファイルで定義したシミュレーションモデルは容易に再リリースできます:
- 必要に応じて、モデルの定義を変更します。
- リンクした Simulation Model Item に関する新しい
Plannedレビジョンを作成します。これは、Vaults パネル内の Item に関する Lifecycle 画面、または Item に関する詳細画面から行えます。後者は、Details ボタン（Item Revision 欄の右にある）をクリックして SimModel ファイルからアクセスできます。 - SimModel ファイルで新しい Item Revision を選択します。
- SimModel ファイルを保存します。
- File » Release To <TargetVaultName> コマンドを使用します。
回路図ライブラリから SimModel ファイルを生成
回路図ライブラリドキュメントから SimModel ファイルを生成できます。
SimModel ファイルを作成するには、Tools » Generate SimModel Files コマンドを使用します。各ファイル（とシミュレーションモデル定義）は、回路図ライブラリ内のコンポーネントに関するシミュレーションモデルリンクに基づいて作成されます。表示される Generate SimModel Files ダイアログで、ソース SimModel ファイルを作成するためにコントロールできます。
ための主要なコマンド。
ダイアログの Options 領域を使用して、ファイルを生成するための設定を行います。最初に、生成するファイルを保存する場所（ソース回路図ライブラリがある場所のサブフォルダ、または指定したフォルダ）を指定します。
以下のオプションを選択できます:
- Overwrite existing files – 新しいファイルが生成される時、同じ名称の既存の SimModel ファイルを上書きします。
- Create folder for each library file – 生成した SimModel ファイルをソース SchLib の名称が付けられたサブフォルダに保存するには、このオプションを使用します。これは、以前にリリースした SimModel ファイルがあるディレクトリへリリースする場合に利点があります。
- Explore generated SimModel files – Windows Explorer が開き、生成した SimModel ファイルがあるフォルダが表示されます。
必要に応じて、オプションを定義した後、OK をクリックします。ファイルの生成が開始され、プロセスが完了すると確認ダイアログが表示されます。また、SimModel ファイルがいくつ生成されたか表示され、参照された .mdl、.ckt、.scb ファイルが SimModel ファイルと一緒に保存されます。
データベースライブラリから SimModel ファイルを生成
データベースライブラリ ドキュメントから SimModel ファイルを生成できます。この機能は、標準の Database Libraries (DbLibs) でのみ利用できます。SimModel ファイルは、SVN Database Libraries (SVNDbLibs) からは生成できません。
SimModel ファイルを作成するには、Tools » Generate SimModel Files コマンドを使用します。各ファイル（とシミュレーションモデル定義）は、データベースライブラリ内の component record に関するシミュレーション情報に基づいて作成されます。表示される Generate SimModel Files ダイアログで、ソース SimModel ファイルを作成するためにコントロールできます。
ための主要なコマンド。
ダイアログの Options 領域を使用して、ファイルを生成するための設定を行います。最初に、生成するファイルを保存する場所（ソース データベースライブラリがある場所のサブフォルダ、または指定したフォルダ）を指定します。
以下のオプションを選択できます:
- Overwrite existing files – 新しいファイルが生成される時、同じ名称の既存の SimModel ファイルを上書きします。
- Create folder for each library file – 生成した SimModel ファイルをソース DbLib の名称が付けられたサブフォルダに保存するには、このオプションを使用します。これは、以前にリリースした SimModel ファイルがあるディレクトリへリリースする場合に利点があります。
- Explore generated SimModel files – Windows Explorer が開き、生成した SimModel ファイルがあるフォルダが表示されます。
必要に応じて、オプションを定義した後、OK をクリックします。ファイルの生成が開始され、プロセスが完了すると確認ダイアログが表示されます。また、SimModel ファイルがいくつ生成されたか表示され、参照された .mdl、.ckt、.scb ファイルが SimModel ファイルと一緒に保存されます。
複数のシミュレーションモデルファイルをリリース
既存のコンポーネント管理 methodology から vault ベースのコンポーネントモデルへ移行する時、1 つのシミュレーションモデル定義が含まれている SimModel ファイルのリリースは冗長なタスク（特に、1 つの SimModel ファイルのリリースでそのファイルを開き、アクティブにする必要があるので）になります。また、ソース SimModel ファイル（Simulation Model Item の新しいレビジョンへ再リリースする必要があります）のシミュレーションモデル定義に変更を反映する場合もです。
同時に、複数の SimModel ファイルを vault へ容易にリリースために、Altium Designer では Release Manager (File » Release Manager) の機能があります。指定したソースフォルダ内にある複数の SimModel ファイルが保存されたシミュレーションモデル定義をバッチでリリースするために、それを使用します。
リリースの準備は以下の方法になります:
- リリースしたい SimModel ファイルが含まれているトップレベルフォルダを指定します。ファイルは、このフォルダ内のサブフォルダに保存できます。
- ターゲット vault を選択します。
- トップレベル Windows フォルダを選択して vault のトップレベルフォルダを作成、または既存の vault フォルダを選択します。Windows サブフォルダごとに、vault フォルダ内にサブフォルダを作成できます。また、ソース SimModel ファイルごとに vault フォルダを作成できます。
- リリースプロセスで新しい Item を作成する方法をコントロールするには（ライフサイクル定義、Item Naming、Item Revision Naming scheme、開始インデックスに関して）、Release Manager の Default Options for New Released Simulation Models 領域を使用します。
- Analyze Folders ボタンをクリックします。
選択したオプションに基づいたソースフォルダやターゲット vault フォルダ（と Item）の解析が実行され、検出されたソース SimModel ファイルのシミュレーションモデル定義がリスト表示されます。各項目には、ターゲット Item（現在と/または次のレビジョンや、リリースプロセスで実行される動作）が表示されます。
リリースしたいシミュレーションモデル定義を有効にしてから Prepare Items and Documents ボタンをクリックして、リリースに関連するソース SimModel ファイルへリンク情報を渡します。保存したら、Release Items ボタンをクリックしてリリースを続行します。
