Usage: mlmm path-opt [OPTIONS]
MEP optimization via the Growing String method or Direct Max Flux.
Options:
--help-advanced Show all options (including advanced settings)
and exit.
-i, --input FILE... Two endpoint structures (reactant/product);
both must be full-enzyme PDBs. [required]
-q, --charge INTEGER Total charge. Required unless --ligand-charge
is provided.
-l, --ligand-charge TEXT Total charge or per-resname mapping (e.g.,
GPP:-3,SAM:1) used to derive charge when -q is
omitted (requires PDB input or --ref-pdb).
-m, --multiplicity INTEGER Spin multiplicity (2S+1). Defaults to 1 when
omitted.
--mep-mode [gsm|dmf] MEP optimizer: Growing String Method (gsm) or
Direct Max Flux (dmf). [default: gsm]
--max-nodes INTEGER Number of internal nodes (string has
max_nodes+2 images including endpoints).
[default: 20]
--max-cycles INTEGER Maximum optimization cycles. [default: 300]
--climb / --no-climb Search for a transition state (climbing image)
after path growth. [default: climb]
--preopt / --no-preopt Pre-optimize the two endpoint structures with
LBFGS before string growth. [default: no-
preopt]
--preopt-max-cycles INTEGER Maximum LBFGS cycles for endpoint pre-
optimization when --preopt=True. [default:
10000]
--fix-ends / --no-fix-ends Fix endpoint structures during path growth.
[default: no-fix-ends]
--dump / --no-dump Dump optimizer trajectory/restarts during the
run. [default: no-dump]
--out-dir TEXT Output directory. [default:
./result_path_opt/]
--thresh [gau_loose|gau|gau_tight|gau_vtight|baker|never]
Convergence preset for the string optimizer.
--config FILE Base YAML configuration file applied before
explicit CLI options.
--show-config / --no-show-config
Print resolved configuration and continue
execution. [default: no-show-config]
--dry-run / --no-dry-run Validate options and print the execution plan
without running path optimization. [default:
no-dry-run]
--parm FILE Amber parm7 topology for the enzyme complex
(MM layers). [required]
--model-pdb FILE PDB defining the ML region (atom IDs used by
the ML/MM calculator). Optional when --detect-
layer is enabled.
--model-indices TEXT Comma-separated atom indices for the ML region
(ranges allowed like 1-5). Used when --model-
pdb is omitted.
--model-indices-one-based / --model-indices-zero-based
Interpret --model-indices as 1-based (default)
or 0-based. [default: model-indices-one-
based]
--detect-layer / --no-detect-layer
Detect ML/MM layers from input PDB B-factors
(B=0/10/20). If disabled, you must provide
--model-pdb or --model-indices. [default:
detect-layer]
--freeze-atoms TEXT Comma-separated 1-based indices to freeze
(applied to every image).
--hess-cutoff FLOAT Distance cutoff (Å) from ML region for MM
atoms to include in Hessian calculation.
Applied to movable MM atoms and can be
combined with --detect-layer.
--movable-cutoff FLOAT Distance cutoff (Å) from ML region for movable
MM atoms. MM atoms beyond this are frozen.
Providing --movable-cutoff disables --detect-
layer.
--convert-files / --no-convert-files
Convert XYZ/TRJ outputs into PDB companions
based on the input format. [default: convert-
files]
-b, --backend [uma|orb|mace|aimnet2]
ML backend for the ONIOM high-level region
(default: uma).
--embedcharge / --no-embedcharge
Enable xTB point-charge embedding correction
for MM→ML environmental effects. [default:
no-embedcharge]
--embedcharge-cutoff FLOAT Distance cutoff (Å) from ML region for MM
point charges in xTB embedding. Default: 12.0
Å when --embedcharge is enabled.
-h, --help Show this message and exit.