.TH gmx-cluster 1 "" "VERSION 5.0.2" "GROMACS Manual"
.SH NAME
gmx-cluster \- Cluster structures

.SH SYNOPSIS
gmx cluster [\-f [<.xtc/.trr/...>]] [\-s [<.tpr/.tpb/...>]]
            [\-n [<.ndx>]] [\-dm [<.xpm>]] [\-om [<.xpm>]] [\-o [<.xpm>]]
            [\-g [<.log>]] [\-dist [<.xvg>]] [\-ev [<.xvg>]]
            [\-conv [<.xvg>]] [\-sz [<.xvg>]] [\-tr [<.xpm>]]
            [\-ntr [<.xvg>]] [\-clid [<.xvg>]] [\-cl [<.xtc/.trr/...>]]
            [\-nice <int>] [\-b <time>] [\-e <time>] [\-dt <time>]
            [\-tu <enum>] [\-[no]w] [\-xvg <enum>] [\-[no]dista]
            [\-nlevels <int>] [\-cutoff <real>] [\-[no]fit]
            [\-max <real>] [\-skip <int>] [\-[no]av] [\-wcl <int>]
            [\-nst <int>] [\-rmsmin <real>] [\-method <enum>]
            [\-minstruct <int>] [\-[no]binary] [\-M <int>] [\-P <int>]
            [\-seed <int>] [\-niter <int>] [\-nrandom <int>]
            [\-kT <real>] [\-[no]pbc]

.SH DESCRIPTION
\fBgmx cluster\fR can cluster structures using several different methods. Distances between structures can be determined from a trajectory or read from an \fB.xpm\fR matrix file with the \fB\-dm\fR option. RMS deviation after fitting or RMS deviation of atom\-pair distances can be used to define the distance between structures.

single linkage: add a structure to a cluster when its distance to any element of the cluster is less than \fBcutoff\fR.

Jarvis Patrick: add a structure to a cluster when this structure and a structure in the cluster have each other as neighbors and they have a least \fBP\fR neighbors in common. The neighbors of a structure are the M closest structures or all structures within \fBcutoff\fR.

Monte Carlo: reorder the RMSD matrix using Monte Carlo such that the order of the frames is using the smallest possible increments. With this it is possible to make a smooth animation going from one structure to another with the largest possible (e.g.) RMSD between them, however the intermediate steps should be as small as possible. Applications could be to visualize a potential of mean force ensemble of simulations or a pulling simulation. Obviously the user has to prepare the trajectory well (e.g. by not superimposing frames). The final result can be inspect visually by looking at the matrix \fB.xpm\fR file, which should vary smoothly from bottom to top.

diagonalization: diagonalize the RMSD matrix.

gromos: use algorithm as described in Daura \fIet al.\fR (\fIAngew. Chem. Int. Ed.\fR \fB1999\fR, \fI38\fR, pp 236\-240). Count number of neighbors using cut\-off, take structure with largest number of neighbors with all its neighbors as cluster and eliminate it from the pool of clusters. Repeat for remaining structures in pool.

When the clustering algorithm assigns each structure to exactly one cluster (single linkage, Jarvis Patrick and gromos) and a trajectory file is supplied, the structure with the smallest average distance to the others or the average structure or all structures for each cluster will be written to a trajectory file. When writing all structures, separate numbered files are made for each cluster.

Two output files are always written:
\fB\-o\fR writes the RMSD values in the upper left half of the matrix and a graphical depiction of the clusters in the lower right half When \fB\-minstruct\fR = 1 the graphical depiction is black when two structures are in the same cluster. When \fB\-minstruct\fR  1 different colors will be used for each cluster.
\fB\-g\fR writes information on the options used and a detailed list of all clusters and their members.

Additionally, a number of optional output files can be written:
\fB\-dist\fR writes the RMSD distribution.
\fB\-ev\fR writes the eigenvectors of the RMSD matrix diagonalization.
\fB\-sz\fR writes the cluster sizes.
\fB\-tr\fR writes a matrix of the number transitions between cluster pairs.
\fB\-ntr\fR writes the total number of transitions to or from each cluster.
\fB\-clid\fR writes the cluster number as a function of time.
\fB\-cl\fR writes average (with option \fB\-av\fR) or central structure of each cluster or writes numbered files with cluster members for a selected set of clusters (with option \fB\-wcl\fR, depends on \fB\-nst\fR and \fB\-rmsmin\fR). The center of a cluster is the structure with the smallest average RMSD from all other structures of the cluster.

.SH OPTIONS
Options to specify input and output files:

.BI "\-f" " [<.xtc/.trr/...>] (traj.xtc) (Input, Optional)"
    Trajectory: xtc trr cpt trj gro g96 pdb tng

.BI "\-s" " [<.tpr/.tpb/...>] (topol.tpr) (Input, Optional)"
    Structure+mass(db): tpr tpb tpa gro g96 pdb brk ent

.BI "\-n" " [<.ndx>] (index.ndx) (Input, Optional)"
    Index file

.BI "\-dm" " [<.xpm>] (rmsd.xpm) (Input, Optional)"
    X PixMap compatible matrix file

.BI "\-om" " [<.xpm>] (rmsd-raw.xpm) (Output)"
    X PixMap compatible matrix file

.BI "\-o" " [<.xpm>] (rmsd-clust.xpm) (Output)"
    X PixMap compatible matrix file

.BI "\-g" " [<.log>] (cluster.log) (Output)"
    Log file

.BI "\-dist" " [<.xvg>] (rmsd-dist.xvg) (Output, Optional)"
    xvgr/xmgr file

.BI "\-ev" " [<.xvg>] (rmsd-eig.xvg) (Output, Optional)"
    xvgr/xmgr file

.BI "\-conv" " [<.xvg>] (mc-conv.xvg) (Output, Optional)"
    xvgr/xmgr file

.BI "\-sz" " [<.xvg>] (clust-size.xvg) (Output, Optional)"
    xvgr/xmgr file

.BI "\-tr" " [<.xpm>] (clust-trans.xpm) (Output, Optional)"
    X PixMap compatible matrix file

.BI "\-ntr" " [<.xvg>] (clust-trans.xvg) (Output, Optional)"
    xvgr/xmgr file

.BI "\-clid" " [<.xvg>] (clust-id.xvg) (Output, Optional)"
    xvgr/xmgr file

.BI "\-cl" " [<.xtc/.trr/...>] (clusters.pdb) (Output, Optional)"
    Trajectory: xtc trr cpt trj gro g96 pdb tng


Other options:

.BI "\-nice" " <int> (19)"
    Set the nicelevel

.BI "\-b" " <time> (0)"
    First frame (ps) to read from trajectory

.BI "\-e" " <time> (0)"
    Last frame (ps) to read from trajectory

.BI "\-dt" " <time> (0)"
    Only use frame when t MOD dt = first time (ps)

.BI "\-tu" " <enum> (ps)"
    Time unit: fs, ps, ns, us, ms, s

.BI "\-[no]w" "  (no)"
    View output \fB.xvg\fR, \fB.xpm\fR, \fB.eps\fR and \fB.pdb\fR files

.BI "\-xvg" " <enum> (xmgrace)"
    xvg plot formatting: xmgrace, xmgr, none

.BI "\-[no]dista" "  (no)"
    Use RMSD of distances instead of RMS deviation

.BI "\-nlevels" " <int> (40)"
    Discretize RMSD matrix in this number of levels

.BI "\-cutoff" " <real> (0.1)"
    RMSD cut\-off (nm) for two structures to be neighbor

.BI "\-[no]fit" "  (yes)"
    Use least squares fitting before RMSD calculation

.BI "\-max" " <real> (-1)"
    Maximum level in RMSD matrix

.BI "\-skip" " <int> (1)"
    Only analyze every nr\-th frame

.BI "\-[no]av" "  (no)"
    Write average iso middle structure for each cluster

.BI "\-wcl" " <int> (0)"
    Write the structures for this number of clusters to numbered files

.BI "\-nst" " <int> (1)"
    Only write all structures if more than this number of structures per cluster

.BI "\-rmsmin" " <real> (0)"
    minimum rms difference with rest of cluster for writing structures

.BI "\-method" " <enum> (linkage)"
    Method for cluster determination: linkage, jarvis\-patrick, monte\-carlo, diagonalization, gromos

.BI "\-minstruct" " <int> (1)"
    Minimum number of structures in cluster for coloring in the \fB.xpm\fR file

.BI "\-[no]binary" "  (no)"
    Treat the RMSD matrix as consisting of 0 and 1, where the cut\-off is given by \fB\-cutoff\fR

.BI "\-M" " <int> (10)"
    Number of nearest neighbors considered for Jarvis\-Patrick algorithm, 0 is use cutoff

.BI "\-P" " <int> (3)"
    Number of identical nearest neighbors required to form a cluster

.BI "\-seed" " <int> (1993)"
    Random number seed for Monte Carlo clustering algorithm: = 0 means generate

.BI "\-niter" " <int> (10000)"
    Number of iterations for MC

.BI "\-nrandom" " <int> (0)"
    The first iterations for MC may be done complete random, to shuffle the frames

.BI "\-kT" " <real> (0.001)"
    Boltzmann weighting factor for Monte Carlo optimization (zero turns off uphill steps)

.BI "\-[no]pbc" "  (yes)"
    PBC check


.SH SEE ALSO
.BR gromacs(7)

More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.