diff --git a/doc/cpptraj.bib b/doc/cpptraj.bib index 412af4f063..96e77b003d 100644 --- a/doc/cpptraj.bib +++ b/doc/cpptraj.bib @@ -444,3 +444,29 @@ @article{Roe2022a title = {{ Quantifying the Effects of Lossy Compression on Energies Calculated from Molecular Dynamics Trajectories}}, year = {2022} } + +@article{Perez2013, +author = {P{\'e}rez-Hern{\'a}ndez, Guillermo and Paul, Fabian and Giorgino, Toni and De Fabritiis, Gianni and No{\'e}, Frank}, + title = "{Identification of slow molecular order parameters for Markov model construction}", + journal = {The Journal of Chemical Physics}, + volume = {139}, + number = {1}, + pages = {015102}, + year = {2013}, + month = {07}, + issn = {0021-9606}, + doi = {10.1063/1.4811489}, + url = {https://doi.org/10.1063/1.4811489}, +} + +@article{Noe2016, +author = {No{\'e}, Frank and Banisch, Ralf and Clementi, Cecilia}, +title = {Commute Maps: Separating Slowly Mixing Molecular Configurations for Kinetic Modeling}, +journal = {Journal of Chemical Theory and Computation}, +volume = {12}, +number = {11}, +pages = {5620-5630}, +year = {2016}, +doi = {10.1021/acs.jctc.6b00762}, +URL = { https://doi.org/10.1021/acs.jctc.6b00762 }, +} diff --git a/doc/cpptraj.lyx b/doc/cpptraj.lyx index 0c372e355a..3f1f3b0bef 100644 --- a/doc/cpptraj.lyx +++ b/doc/cpptraj.lyx @@ -20011,7 +20011,7 @@ Mod \begin_layout Standard \align center \begin_inset Tabular - + @@ -21416,6 +21416,36 @@ Calculate a matrix of the specified type from input coordinates. \begin_inset Text +\begin_layout Plain Layout +mindist/maxdist +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +Calculate the minimum or maximum distance between pairs of atoms/residues/molecu +les. +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout + +\end_layout + +\end_inset + + + + +\begin_inset Text + \begin_layout Plain Layout minimage \end_layout @@ -34322,24 +34352,128 @@ matrix dist @CA out distmat.dat \end_layout \begin_layout Subsection -mindist +mindist/maxdist \end_layout -\begin_layout Standard -This functionality is now part of the +\begin_layout LyX-Code +{min|max}dist mask1 [mask2 ] [{byatom|byres|bymol}] +\end_layout + +\begin_layout LyX-Code + [noimage] [name ] [out ] [resoffset <#>] +\end_layout + +\begin_deeper +\begin_layout Description +mask1 +\begin_inset space ~ +\end_inset + + First mask for selecting atoms. +\end_layout + +\begin_layout Description +[mask2 +\begin_inset space ~ +\end_inset + +] Optional second mask for selecting atoms. +\end_layout + +\begin_layout Description +[{byatom|byres|bymol}] +\end_layout + +\begin_deeper +\begin_layout Description +byatom Report the minimum or maximum distance between atoms in or + between atoms in and atoms in . +\end_layout + +\begin_layout Description +byres Report the minimum or maximum distance between all residue pairs selected + by , or pairs of residues selected by and residues selected + by (excluding certain pairs, see \series bold -\emph on -nativecontacts +resoffset \series default -\emph default - command; see -\begin_inset CommandInset ref -LatexCommand vref -reference "subsec:cpptraj-nativecontacts" +). +\end_layout + +\begin_layout Description +bymol Report the minimum or maximum distance between all molecule pairs + selected by , or pairs of molecules selected by and molecules + selected by . +\end_layout + +\end_deeper +\begin_layout Description +[noimage] Do not use the minimum image convention for distances. +\end_layout +\begin_layout Description +[name +\begin_inset space ~ \end_inset -. +] Output data set name. +\end_layout + +\begin_layout Description +[out +\begin_inset space ~ +\end_inset + +] Write data to . +\end_layout + +\begin_layout Description +[resoffset +\begin_inset space ~ +\end_inset + +<#>] For +\series bold +byres +\series default +, ignore residue pairs if the difference in residue numbers is greater than + the cutoff (default 1). +\end_layout + +\begin_layout Standard +Data Sets Created: +\end_layout + +\begin_layout Description + For +\series bold +byatom +\series default +, a set containing the minimum or maximum distance for each frame. +\end_layout + +\begin_layout Description +[<#>_<#>] For +\series bold +byres +\series default +/ +\series bold +b +\series default +ymol, a set containing the minimum or maximum distance between the residue/molec +ule pair specified by the numbers in the aspect, e.g. + '[1_3]' for +\series bold +byres +\series default + would be between residues 1 and 3. +\end_layout + +\end_deeper +\begin_layout Standard +Calculate the minimum or maximum distance in Angstroms between atoms or + residue/molecule pairs. \end_layout \begin_layout Subsection @@ -37122,6 +37256,13 @@ principal :1-76 dorotation out principal.dat \begin_layout Subsection projection +\begin_inset CommandInset label +LatexCommand label +name "subsec:cpptraj-projection" + +\end_inset + + \end_layout \begin_layout LyX-Code @@ -37130,7 +37271,7 @@ projection [] evecs [out ] [beg ] [end \end_layout \begin_layout LyX-Code - [] [dihedrals ] + {[] | [dihedrals ] | [data ...]} \end_layout \begin_layout LyX-Code @@ -37200,6 +37341,21 @@ arg>] (Dihedral covariance only) Dihedral data sets to use in projection; MUST CORRESPOND TO HOW EIGENVECTORS WERE GENERATED. \end_layout +\begin_layout Description +[data +\begin_inset space ~ +\end_inset + +] (Data covariance only, e.g. + from TICA). + 1D data sets to use in projection; MUST CORRESPOND TO HOW EIGENVECTORS + WERE GENERATED. +\end_layout + \begin_layout Description [start \begin_inset space ~ @@ -37263,6 +37419,12 @@ Projects snapshots onto eigenvectors obtained by diagonalizing covariance diagmatrix \series default \shape default +/ +\series bold +\emph on +tica +\series default +\emph default ) or previously read-in (e.g. with \series bold @@ -37283,9 +37445,11 @@ readdata \family sans \series bold +\emph on matrix \family default \series default +\emph default \begin_inset Quotes erd \end_inset @@ -37305,6 +37469,23 @@ projection \series default \emph default command. + If only 1D data sets need to be projected, see the +\series bold +\emph on +projectdata +\series default +\emph default + analysis command, +\begin_inset CommandInset ref +LatexCommand vref +reference "subsec:cpptraj-projectdata" +plural "false" +caps "false" +noprefix "false" + +\end_inset + +. \end_layout \begin_layout Subsection @@ -43058,7 +43239,7 @@ trajin \begin_layout Standard \align center \begin_inset Tabular - + @@ -44096,6 +44277,35 @@ N phi/psi dihedrals \begin_inset Text +\begin_layout Plain Layout +projectdata +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +Project data along eigenmodes. +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +eigenmodes, N 1D scalar +\end_layout + +\end_inset + + + + +\begin_inset Text + \begin_layout Plain Layout regress \end_layout @@ -44364,6 +44574,35 @@ N 1D scalar \begin_inset Text +\begin_layout Plain Layout +tica +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +Perform time-independent correlation analysis. +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +COORDS, N 1D scalar +\end_layout + +\end_inset + + + + +\begin_inset Text + \begin_layout Plain Layout timecorr \end_layout @@ -48219,7 +48458,7 @@ name "subsec:diagmatrix-|-analyze" \end_layout \begin_layout LyX-Code -diagmatrix [out ] [thermo [outthermo ]] +diagmatrix [out ] [thermo [outthermo ]] \end_layout \begin_layout LyX-Code @@ -48238,7 +48477,11 @@ diagmatrix [out ] [thermo [outthermo ]] \begin_layout Description \series bold - + \series default Name of symmetric matrix to diagonalize. \end_layout @@ -51556,6 +51799,130 @@ run phipsi DPDP[phi] DPDP[psi] out phipsi.dat resrange 1-22 \end_layout +\begin_layout Subsection +projectdata +\begin_inset CommandInset label +LatexCommand label +name "subsec:cpptraj-projectdata" + +\end_inset + + +\end_layout + +\begin_layout LyX-Code +projectdata evecs [name ] [out ] [beg ] + [end ] +\end_layout + +\begin_layout LyX-Code + {[dihedrals ] | [data ...]} +\end_layout + +\begin_deeper +\begin_layout Description +evecs +\begin_inset space ~ +\end_inset + + Data set containing eigenvectors (modes). +\end_layout + +\begin_layout Description +[name +\begin_inset space ~ +\end_inset + +] Output data set name. +\end_layout + +\begin_layout Description +[out +\begin_inset space ~ +\end_inset + +] Write projections to . +\end_layout + +\begin_layout Description +[beg +\begin_inset space ~ +\end_inset + +] First eigenvector/mode to use (default 1). +\end_layout + +\begin_layout Description +[end +\begin_inset space ~ +\end_inset + +] Final eigenvector/mode to use (default 2). +\end_layout + +\begin_layout Description +[dihedrals +\begin_inset space ~ +\end_inset + +] (Dihedral covariance only) Dihedral data sets to use in projection; + MUST CORRESPOND TO HOW EIGENVECTORS WERE GENERATED. +\end_layout + +\begin_layout Description +[data +\begin_inset space ~ +\end_inset + +] (Data covariance only, e.g. + from TICA). + 1D data sets to use in projection; MUST CORRESPOND TO HOW EIGENVECTORS + WERE GENERATED. +\end_layout + +\begin_layout Standard +Data Sets Created: +\end_layout + +\begin_layout Description +:<#> Projection data set for mode <#>. +\end_layout + +\end_deeper +\begin_layout Standard +Project data along previously generated eigenmodes from e.g. + PCA or TICA. + This is a faster alternative to the +\series bold +\emph on +projection +\series default +\emph default + command ( +\begin_inset CommandInset ref +LatexCommand vref +reference "subsec:cpptraj-projection" +plural "false" +caps "false" +noprefix "false" + +\end_inset + +) if only 1D data sets need to be projected. +\end_layout + \begin_layout Subsection regress \end_layout @@ -53661,6 +54028,172 @@ ti TIdata nq 9 name Curve out skip.agr curveout curve.agr nskip 0,5,10,15,20,30, ,50 \end_layout +\begin_layout Subsection +tica +\end_layout + +\begin_layout LyX-Code +tica { crdset [mask ] | +\end_layout + +\begin_layout LyX-Code + data ... + } +\end_layout + +\begin_layout LyX-Code + [lag