CLI 規約

このページでは、pdb2reaction の全コマンドで使用される規約を説明します。これらの規約を理解することで、正しいコマンドを記述し、よくあるエラーを回避できます。

ブール値オプション

すべてのブール値 CLI オプションには明示的な値が必要です。フラグ形式の --tsopt 単独では動作しません：

# 正しい（以下はすべて有効）
--tsopt True --thermo True --dft False
--tsopt true --thermo TRUE --dft false   # 大文字小文字は区別しない
--tsopt 1 --thermo yes --dft 0           # 1/0, yes/no も可

# 間違い（動作しない）
--tsopt         # フラグ形式（値なし）は非対応

CLI は真値として True, true, TRUE, 1, yes, Yes, y, t を、偽値として False, false, FALSE, 0, no, No, n, f を受け入れます。

よく使うブール値オプション：

  • --tsopt, --thermo, --dft — 後処理ステージの有効化

  • --freeze-links — リンク水素の親原子を凍結（デフォルト: True）

  • --dump — 軌跡ファイルの出力

  • --preopt, --endopt — 前処理/後処理最適化の切り替え

  • --climb — MEP 探索でクライミングイメージを有効化

  • --convert-files — PDB/GJF コンパニオンファイルの生成

残基セレクタ

残基セレクタは、基質や抽出中心として使用する残基を指定します。

残基名による指定

-c 'SAM,GPP'          # SAM または GPP という名前の残基をすべて選択
-c 'LIG'              # LIG という名前の残基をすべて選択

残基IDによる指定

-c '123,456'          # 残基 123 と 456
-c 'A:123,B:456'      # チェーン A の残基 123、チェーン B の残基 456
-c '123A'             # 挿入コード A を持つ残基 123
-c 'A:123A'           # チェーン A、残基 123、挿入コード A

PDB ファイルによる指定

-c substrate.pdb      # 別の PDB から座標を使用して基質を特定

Note

残基名で選択する場合、同名の残基が複数あればすべてが含まれ、警告がログに出力されます。

電荷の指定

残基別マッピング（推奨）

--ligand-charge 'SAM:1,GPP:-3'    # SAM は +1、GPP は -3
--ligand-charge 'LIG:-2'          # LIG は -2

総電荷の明示的上書き

-q 0                              # 総電荷を 0 に強制
-q -1                             # 総電荷を -1 に強制

電荷の解決順序

  1. -q/--charge（明示的な CLI 上書き）— 最優先

  2. ポケット抽出（アミノ酸、イオン、--ligand-charge の合計）

  3. フォールバックとしての --ligand-charge（抽出がスキップされた場合）

  4. .gjf テンプレートのメタデータ

  5. デフォルト: なし（未解決なら中断。-q/.gjf 電荷メタデータ、または PDB の --ligand-charge で解決）

Note

--ligand-charge による導出は、PDB 入力のみ（--ref-pdb を付けた XYZ/GJF 入力を含む）で電荷がまだ解決されていない場合に適用されます。.gjf テンプレートが --ligand-charge の評価前に電荷値を提供している場合、テンプレートの電荷が優先され、--ligand-charge は上書きしません。

Tip

非標準の残基（基質、補因子、特殊なリガンド）には必ず --ligand-charge を指定し、正しい電荷伝播を確保してください。

スピン多重度

-m 1      # 一重項（デフォルト）
-m 2      # 二重項
-m 3      # 三重項

Note

all コマンドでは -m/--mult を使用します。他のサブコマンドでは -m/--multiplicity を使用します。

原子セレクタ

原子セレクタは、スキャンや拘束に使用する特定の原子を指定します。指定方法は以下の通りです：

整数インデックス（デフォルトは1始まり）

--scan-lists '[(1, 5, 2.0)]'      # 原子 1 と 5、ターゲット距離 2.0 Å

PDB形式のセレクタ文字列

--scan-lists '[("TYR,285,CA", "MMT,309,C10", 2.20)]'

セレクタのフィールドは以下で区切れます：

  • 空白: 'TYR 285 CA'

  • カンマ: 'TYR,285,CA'

  • スラッシュ: 'TYR/285/CA'

  • バッククォート: 'TYR`285`CA'

  • バックスラッシュ: 'TYR\285\CA'

3つのトークン（残基名、残基番号、原子名）は任意の順序で指定できます。パーサーは順序が標準的でない場合にフォールバックヒューリスティックを使用します。

入力ファイル要件

PDB ファイル

  • 水素原子を含む必要があります（reduce、pdb2pqr、または Open Babel で追加）

  • 列 77-78 に元素記号が必要（欠けている場合は pdb2reaction add-elem-info を使用）

  • 複数の PDB は同じ原子を同じ順序で持つ必要があります（座標のみ異なる）

XYZ および GJF ファイル

  • ポケット抽出をスキップする場合に使用可能（-c/--center を省略）

  • .gjf ファイルは埋め込みメタデータから電荷/スピンのデフォルトを提供可能

YAML 設定

詳細設定は --args-yaml で渡せます：

pdb2reaction all -i R.pdb P.pdb -c 'LIG' --args-yaml config.yaml

YAML 値が最優先されます：

デフォルト → CLI オプション → YAML（最優先）

利用可能なすべてのオプションは YAML リファレンス を参照してください。

出力ディレクトリ

--out-dir で結果の保存先を指定します：

--out-dir ./my_results/    # カスタム出力ディレクトリ

デフォルトの出力ディレクトリ：

  • all: ./result_all/

  • extract: カレントディレクトリまたは指定の -o

  • opt: ./result_opt/

  • tsopt: ./result_tsopt/

  • path-opt: ./result_path_opt/

  • path-search: ./result_path_search/

  • scan: ./result_scan/

  • freq: ./result_freq/

  • irc: ./result_irc/

  • dft: ./result_dft/

関連項目