実行コマンド構文
Cubitは、GUIアプリケーション、コマンドラインアプリケーション、およびPythonモジュールとして利用できます。
- 外部のPythonインタープリタからCubitをモジュールとしてインポートするには、Cubitインストール先の bin ディレクトリがPythonのモジュール検索パスに含まれていることを確認します。これは、Pythonを起動する前に PYTHONPATH を設定するか、そのディレクトリを sys.path へ追加してからimport cubitを実行することで設定できます。
- CubitのGUIアプリケーションを直接起動するには、次を実行します。 bin/clarox (インストールディレクトリから実行)。
- Cubitのコマンドラインアプリケーションを直接起動するには、次を実行します。 bin/cubitx。これもインストールディレクトリから実行します。
インストールルートには追加のランチャースクリプトも用意されています。そのディレクトリから coreform_cubit を実行するとGUIアプリケーションが起動します。また、 -nogui オプションを指定するとコマンドラインアプリケーションが起動します。
注:バッチモードで実行する場合は、次の実行方法を強く推奨します。 coreform_cubit.
コマンドラインアプリケーションの構文は次のとおりです。
coreform_cubit [options and args] [journalFile(s)]
bin/cubitx [options and args] [journalFile(s)]
bin/clarox [options and args] [journalFile(s)]
入力するjournalFileまたはスクリプトは、他のすべてのオプションの後に指定できます。スクリプトにはCubit構文またはPython構文を使用できます。拡張子が .py の場合はPython構文として扱われます。 .jou ファイルまたはその他の拡張子のファイルでは、ファイル内の #!cubit または #!python コメントによって構文の解釈方法を指定します。
コマンドラインで使用できるオプションは次のとおりです。
cubit
-help (この概要を表示)
-Include <$val> (ジャーナルファイルを指定)
-workingdir <$val> (作業ディレクトリとして使用するディレクトリ)
-input $val (指定したファイル内のコマンドを再生)
-solidmodel <$val> (Read .sat, .cub or .exo from file $val)
-nogeom (-solidmodelで指定した.exoを、ジオメトリを作成せずに読み込む)
-lite (-solidmodelで指定した.exoをliteモードで読み込む)
-fastq <$val> (指定したFASTQファイルを読み込む)
-initfile <$val> (指定したファイルを初期化ファイルとして読み込む。
既定のHOME/.cubitの代わりに使用)
-batch (バッチモード — 対話的なコマンド入力なし)
-nographics (グラフィックスウィンドウを表示しない)
-nogui (GUIを表示しない)
-noinitfile (.cubitファイルを読み込まない)
-noecho (コマンドをコンソールへエコー表示しない)
-nojournal (ジャーナルファイルを書き出さない)
-nodeletions (ファイル削除を許可しない)
-journalfile <$val> (Name of journal file, will be overwritten)
-restore [$val] (復元ファイル名。既定値はcubit_geom.save.sat)
-maxjournal [$val] (書き込むジャーナルファイルの最大数)
-warning [$val] (警告メッセージのオン/オフ)
-information [$val] (情報メッセージのオン/オフ)
-debug <$val> (指定したフラグをオンにします。例:1,3,7-9
を指定すると1,3,7,8,9が有効になります)
-display <$val> (使用するディスプレイを指定)
graphics window)
-driver <$val> (使用するドライバの種類を指定)
graphics display)
-nooverwritecheck (ファイルエクスポート時の上書きチェックを行わない)
-nobanner (起動情報の表示を抑制)
-version (バージョン情報を表示)
-log <$val> (すべての出力を指定ファイルへコピー)
-python_version <version> (使用するPythonのメジャーバージョン:2または3)
APREPRO変数ペア (引用符で囲んだ名前と値のペア)
これらはすべて省略可能です。指定する場合、角括弧内の項目 [$val]は省略可能で、山括弧内の項目 <$val>は必須です。
各オプションを以下で詳しく説明します。
| -help |
コマンド構文の簡単な使用方法をターミナルに表示して終了します。 |
|
| -workingdir |
起動時に使用する作業ディレクトリを設定します。ジャーナルファイルはこのディレクトリへ書き込まれます。 |
|
| -initfile <$val> |
で指定したファイルを <$val> 既定の初期化ファイル群の代わりに初期化ファイルとして使用します。詳しくは 初期化ファイル |
|
| -noinitfile |
初期化ファイルを読み込みません。これは初期化ファイルで説明されている既定動作を上書きします。 初期化ファイル |
|
| -solidmodel <$val> |
で指定したファイルからACISソリッドモデルのジオメトリまたは.cubファイル情報を読み込み、 <$val> 対話入力のプロンプトを表示する前に処理します。 |
|
| -batch |
このCUBIT実行では対話入力を行わないことを指定します。CUBITは初期化ファイル、ジオメトリファイル、および input_file_listを読み込んだ後に終了します。 |
|
| -nographics |
グラフィックスなしでCUBITを実行します。通常は-batchオプションと組み合わせるか、ライン端末からCUBITを実行する場合に使用します。 |
|
| -nogui |
GUIなしでCUBITを実行します。 |
|
| -display |
CUBITのグラフィックスシステムを表示する場所を設定します。X Window Systemの -display 環境変数と同様の指定です。Unixのみ。 |
|
| -driver <type> |
使用するグラフィックス表示ドライバの <type> 種類を設定します。利用可能なドライバはプラットフォーム、ハードウェア、システム構成によって異なります。代表例は X11 および OpenGL. |
|
| -nojournal |
このCUBIT実行ではジャーナルファイルを作成しません。このオプションはJournal Offコマンドと同じ機能です。既定ではCUBITを実行するたびに新しいジャーナルファイルを作成します。 |
|
| -journalfile <file> |
ジャーナルエントリを <file>へ書き込みます。ファイルがすでに存在する場合は上書きされます。 |
|
| -maxjournal <$val> |
作成する既定のジャーナルファイル数を最大 <$val> に制限します。既定のジャーナルファイル名はcubit#.jou形式で、#は01から999までの番号です。 |
|
| -nodeletions |
次のコマンドによるファイル削除機能を無効にします。 delete file '<filename>' |
|
| -nooverwritecheck |
ファイル上書きチェックフラグを無効にします。これにより、書き込み時に警告なしで同名の既存ファイルを上書きできます。既存の出力ファイルを更新するためにジャーナルファイルを再実行する場合などに便利です。詳しくは set File Overwrite Check [ON|off] |
|
| -restore |
指定したファイル名(またはcubit_geom)のメッシュファイルとACISファイルを復元します。例:cubit_geom.save.g、cubit_geom.save.sat。 |
|
| -noecho |
コマンドをコンソールへエコー表示しません。このオプションはEcho Offコマンドと同じ機能です。既定ではコマンドがコンソールへエコー表示されます。 |
|
| -debug <$val> |
Set to "on" the debug message flags indicated by <$val>。ここで <$val> は、1,3,8-10のようにカンマ区切りで指定する整数または整数範囲の一覧です。 |
|
| -information {on|off} |
CUBITからコンソールへの情報メッセージ表示を {on|off} 切り替えます。 |
|
| -warning {on|off} |
CUBITからコンソールへの情報メッセージ表示を {on|off} CUBITからコンソールへの警告メッセージ表示を切り替えます。 |
|
| -Include <path> |
コマンドラインからジャーナルファイルを指定できます。 |
|
| -fastq <file> |
FASTQファイル内のメッシュおよびジオメトリ定義データを読み込み、 <file> そのデータをFASTQコマンドとして解釈します。FASTQファイル形式については、T. D. Blacker, FASTQ Users Manual Version 1.2, SAND88-1326, Sandia National Laboratories (1988)を参照してください。 |
|
| <input_file_list> |
CUBITが読み込んで実行する入力ファイルを指定します。ファイルは列挙順に処理され、その後、-batchオプションを使用していなければ対話的にコマンドを入力できます。 入力ファイルにはCubit構文またはPython構文を使用できます。 |
|
| -log <file> |
すべての出力を指定したファイルへコピーします。 |
|
| -python_version <version> |
使用するPythonのメジャーバージョンを2または3で指定します。 |
|
| <variable=value> |
CUBITセッションで使用するAPREPROの変数と値のペアを指定します。値にはdouble型または文字列型を使用でき、文字列値はダブルクォートで囲む必要があります。コマンドオプションは CUBIT_OPT 環境変数でも指定できます( 環境変数 .) |
|
CUBITセッションへの変数の引き渡し
APREPRO変数をCUBITセッションへ渡すには、変数定義を引用符で囲み、Cubitの起動時に指定します。 "some_var=2.3"