Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Command line

cargo run --release <path_to_parm7> <path_to_nc> [--torsions-only] [--no-periodic] [--exact-constant] [--start N] [--stop N] [--stride N] [--mie-order 1|2|3|4] [--theiler-window W] [--tree-bonds] [--drop-constrained] [--no-phase-angles] [--jacobian] [--estimator nn|qh|bqh|split] [--histogram-bins N] [--periodic-correlation complex|centered] [--per-coordinate] [--mutual-information] [--soft topology|detect|LIST] [--soft-estimator mie|mist|network|joint] [--network-parents N] [--hard-estimator qh|bqh|qh-mie1|qh-mie2] [--coupling gaussian|states|none] [--soft-features complex|cossin|harmonics] [--harmonics N] [--state-torsions auto|LIST] [--min-state-frames N]

Example:

cargo run --release <path_to_parm7> <path_to_nc>

Options

  • For most molecules --estimator bqh is the most accurate choice; see Validation. The default estimator is the NN MIE.
  • --torsions-only drops the bonds and angles and estimates the entropy of the torsions alone.
  • --stop limits the number of frames read to N.
  • --start skips the first N frames.
  • --stride retains every Nth frame after --start (default: 1). Choose a stride based on a separate correlation-time analysis; the crate does not estimate an effective sample size automatically.
  • --mie-order selects the expansion order of the NN MIE. The default is 2.
  • --no-periodic forces every coordinate to use an ordinary linear metric. This produces a significant speedup, but the torsion entropy contribution loses some correctness.
  • --theiler-window W excludes temporally adjacent frames from the nearest-neighbor search: frame i's neighbor must satisfy |i - j| > W, counted in frames after --start and --stride. The default, 0, is the plain estimator. See Correlated frames.
  • --exact-constant uses the exact finite-sample term psi(N) - psi(1) = H_(N-1). The default is the common approximation ln(N) + EulerGamma.
  • --tree-bonds uses the bonds of the BAT spanning tree, including bonds to hydrogen and excluding ring closures, in place of every heavy-atom bond. Use it only for trajectories without constrained bonds to hydrogen, or with --drop-constrained; see Choosing the bond set.
  • --drop-constrained drops every bond and angle the trajectory shows to be constrained (relative standard deviation below 10⁻³ over the frames read) and prints Constrained coordinates dropped = N first. With the default bonds, bonds to hydrogen are then kept unless constrained; with --tree-bonds, the constrained tree bonds go but still count in --jacobian. See Constrained coordinates.
  • --no-phase-angles uses the raw torsions. By default each torsion that shares its central bond with an earlier torsion is replaced by its offset from that torsion. See Coordinate sets.
  • --jacobian also prints Mean ln J = ..., the mean of the log BAT Jacobian over the frames used, on the line before the entropy. It requires --tree-bonds and cannot be combined with --torsions-only.
  • With --estimator qh or bqh, two lines before the total give the terms it is the sum of: First-order entropy = ... and Correlation term = ....
  • --estimator chooses the estimator: nn (the default) is the nearest-neighbor MIE, qh is quasi-harmonic, bqh is Boltzmann quasi-harmonic, and split treats soft torsions non-parametrically and the rest with a Gaussian (see Split estimator). See Quasi-harmonic estimators. --mie-order applies only to nn.
  • --histogram-bins N makes bqh estimate each coordinate's first-order entropy from an N-bin histogram instead of nearest neighbors.
  • --per-coordinate also prints a tab-separated table of each coordinate's share of the entropy before the total: its number, type (bond, angle, torsion or phase angle), atoms (numbered from 1, as in Amber and cpptraj), and entropy. The shares sum to the total. It works with --estimator nn at every --mie-order; with qh and bqh, for which the table has two more columns, first_order and correlation, the two terms each coordinate's entropy is the sum of; and with split, for which it has set (soft or hard), own and coupling. It cannot be combined with --soft-estimator joint. See Per-coordinate entropies.
  • --mutual-information also prints a tab-separated table of the mutual information of every pair of coordinates, numbered as in --per-coordinate. It applies only to --estimator nn.
  • With --estimator split: --soft topology|detect|LIST chooses the soft coordinates (default topology; LIST counts from 1), --soft-estimator mie|mist|network|joint (with --network-parents N, default 5, for network) and --hard-estimator qh|bqh|qh-mie1|qh-mie2 the estimators for each set, --coupling gaussian|states|none the coupling term, --soft-features complex|cossin|harmonics and --harmonics N how soft torsions enter the Gaussian coupling (default: 3 harmonics), and --state-torsions auto|LIST and --min-state-frames N the states of the per-state coupling. --mie-order, --histogram-bins and --periodic-correlation apply to the matching part. The output lists the soft coordinates, the states, and Soft entropy, Hard entropy and Coupling term before the total. See Split estimator.
  • --periodic-correlation complex|centered sets how torsions enter the quasi-harmonic correlation term; complex, the default for qh and bqh, is Harpole and Sharp's e^{iφ}; centered is the default for the hard set of split. See Quasi-harmonic estimators.