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 bqhis the most accurate choice; see Validation. The default estimator is the NN MIE. --torsions-onlydrops the bonds and angles and estimates the entropy of the torsions alone.--stoplimits the number of frames read to N.--startskips the first N frames.--strideretains 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-orderselects the expansion order of the NN MIE. The default is 2.--no-periodicforces every coordinate to use an ordinary linear metric. This produces a significant speedup, but the torsion entropy contribution loses some correctness.--theiler-window Wexcludes temporally adjacent frames from the nearest-neighbor search: frame i's neighbor must satisfy |i - j| > W, counted in frames after--startand--stride. The default, 0, is the plain estimator. See Correlated frames.--exact-constantuses the exact finite-sample termpsi(N) - psi(1) = H_(N-1). The default is the common approximationln(N) + EulerGamma.--tree-bondsuses 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-constraineddrops every bond and angle the trajectory shows to be constrained (relative standard deviation below 10⁻³ over the frames read) and printsConstrained coordinates dropped = Nfirst. 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-anglesuses 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.--jacobianalso printsMean ln J = ..., the mean of the log BAT Jacobian over the frames used, on the line before the entropy. It requires--tree-bondsand cannot be combined with--torsions-only.- With
--estimator qhorbqh, two lines before the total give the terms it is the sum of:First-order entropy = ...andCorrelation term = .... --estimatorchooses the estimator:nn(the default) is the nearest-neighbor MIE,qhis quasi-harmonic,bqhis Boltzmann quasi-harmonic, andsplittreats soft torsions non-parametrically and the rest with a Gaussian (see Split estimator). See Quasi-harmonic estimators.--mie-orderapplies only tonn.--histogram-bins Nmakesbqhestimate each coordinate's first-order entropy from an N-bin histogram instead of nearest neighbors.--per-coordinatealso prints a tab-separated table of each coordinate's share of the entropy before the total: its number, type (bond,angle,torsionorphase angle), atoms (numbered from 1, as in Amber and cpptraj), and entropy. The shares sum to the total. It works with--estimator nnat every--mie-order; withqhandbqh, for which the table has two more columns,first_orderandcorrelation, the two terms each coordinate's entropy is the sum of; and withsplit, for which it hasset(softorhard),ownandcoupling. It cannot be combined with--soft-estimator joint. See Per-coordinate entropies.--mutual-informationalso 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|LISTchooses the soft coordinates (defaulttopology; LIST counts from 1),--soft-estimator mie|mist|network|joint(with--network-parents N, default 5, fornetwork) and--hard-estimator qh|bqh|qh-mie1|qh-mie2the estimators for each set,--coupling gaussian|states|nonethe coupling term,--soft-features complex|cossin|harmonicsand--harmonics Nhow soft torsions enter the Gaussian coupling (default: 3 harmonics), and--state-torsions auto|LISTand--min-state-frames Nthe states of the per-state coupling.--mie-order,--histogram-binsand--periodic-correlationapply to the matching part. The output lists the soft coordinates, the states, andSoft entropy,Hard entropyandCoupling termbefore the total. See Split estimator. --periodic-correlation complex|centeredsets how torsions enter the quasi-harmonic correlation term;complex, the default forqhandbqh, is Harpole and Sharp'se^{iφ};centeredis the default for the hard set ofsplit. See Quasi-harmonic estimators.