New entry
[gromacs/rigid-bodies.git] / man / man1 / g_rms.1
blob4ae7172710b9aac76aa1bcdf2d7d7bfe5f800eb5
1 .TH g_rms 1 "Mon 4 Apr 2011" "" "GROMACS suite, VERSION 4.5.4-dev-20110404-bc5695c"
2 .SH NAME
3 g_rms - calculates rmsd's with a reference structure and rmsd matrices
5 .B VERSION 4.5.4-dev-20110404-bc5695c
6 .SH SYNOPSIS
7 \f3g_rms\fP
8 .BI "\-s" " topol.tpr "
9 .BI "\-f" " traj.xtc "
10 .BI "\-f2" " traj.xtc "
11 .BI "\-n" " index.ndx "
12 .BI "\-o" " rmsd.xvg "
13 .BI "\-mir" " rmsdmir.xvg "
14 .BI "\-a" " avgrp.xvg "
15 .BI "\-dist" " rmsd\-dist.xvg "
16 .BI "\-m" " rmsd.xpm "
17 .BI "\-bin" " rmsd.dat "
18 .BI "\-bm" " bond.xpm "
19 .BI "\-[no]h" ""
20 .BI "\-[no]version" ""
21 .BI "\-nice" " int "
22 .BI "\-b" " time "
23 .BI "\-e" " time "
24 .BI "\-dt" " time "
25 .BI "\-tu" " enum "
26 .BI "\-[no]w" ""
27 .BI "\-xvg" " enum "
28 .BI "\-what" " enum "
29 .BI "\-[no]pbc" ""
30 .BI "\-fit" " enum "
31 .BI "\-prev" " int "
32 .BI "\-[no]split" ""
33 .BI "\-skip" " int "
34 .BI "\-skip2" " int "
35 .BI "\-max" " real "
36 .BI "\-min" " real "
37 .BI "\-bmax" " real "
38 .BI "\-bmin" " real "
39 .BI "\-[no]mw" ""
40 .BI "\-nlevels" " int "
41 .BI "\-ng" " int "
42 .SH DESCRIPTION
43 \&\fB g_rms\fR compares two structures by computing the root mean square
44 \&deviation (RMSD), the size\-independent rho similarity parameter
45 \&(\fB rho\fR) or the scaled rho (\fB rhosc\fR), 
46 \&see Maiorov & Crippen, Proteins \fB 22\fR, 273 (1995).
47 \&This is selected by \fB \-what\fR.
49 Each structure from a trajectory (\fB \-f\fR) is compared to a
50 \&reference structure. The reference structure
51 \&is taken from the structure file (\fB \-s\fR).
54 \&With option \fB \-mir\fR also a comparison with the mirror image of
55 \&the reference structure is calculated.
56 \&This is useful as a reference for 'significant' values, see
57 \&Maiorov & Crippen, Proteins \fB 22\fR, 273 (1995).
60 \&Option \fB \-prev\fR produces the comparison with a previous frame
61 \&the specified number of frames ago.
64 \&Option \fB \-m\fR produces a matrix in \fB .xpm\fR format of
65 \&comparison values of each structure in the trajectory with respect to
66 \&each other structure. This file can be visualized with for instance
67 \&\fB xv\fR and can be converted to postscript with \fB xpm2ps\fR.
70 \&Option \fB \-fit\fR controls the least\-squares fitting of
71 \&the structures on top of each other: complete fit (rotation and
72 \&translation), translation only, or no fitting at all.
75 \&Option \fB \-mw\fR controls whether mass weighting is done or not.
76 \&If you select the option (default) and 
77 \&supply a valid \fB .tpr\fR file masses will be taken from there, 
78 \&otherwise the masses will be deduced from the \fB atommass.dat\fR file in
79 \&\fB GMXLIB\fR. This is fine for proteins, but not
80 \&necessarily for other molecules. A default mass of 12.011 amu (carbon)
81 \&is assigned to unknown atoms. You can check whether this happend by
82 \&turning on the \fB \-debug\fR flag and inspecting the log file.
85 \&With \fB \-f2\fR, the 'other structures' are taken from a second
86 \&trajectory, this generates a comparison matrix of one trajectory
87 \&versus the other.
90 \&Option \fB \-bin\fR does a binary dump of the comparison matrix.
93 \&Option \fB \-bm\fR produces a matrix of average bond angle deviations
94 \&analogously to the \fB \-m\fR option. Only bonds between atoms in the
95 \&comparison group are considered.
96 .SH FILES
97 .BI "\-s" " topol.tpr" 
98 .B Input
99  Structure+mass(db): tpr tpb tpa gro g96 pdb 
101 .BI "\-f" " traj.xtc" 
102 .B Input
103  Trajectory: xtc trr trj gro g96 pdb cpt 
105 .BI "\-f2" " traj.xtc" 
106 .B Input, Opt.
107  Trajectory: xtc trr trj gro g96 pdb cpt 
109 .BI "\-n" " index.ndx" 
110 .B Input, Opt.
111  Index file 
113 .BI "\-o" " rmsd.xvg" 
114 .B Output
115  xvgr/xmgr file 
117 .BI "\-mir" " rmsdmir.xvg" 
118 .B Output, Opt.
119  xvgr/xmgr file 
121 .BI "\-a" " avgrp.xvg" 
122 .B Output, Opt.
123  xvgr/xmgr file 
125 .BI "\-dist" " rmsd\-dist.xvg" 
126 .B Output, Opt.
127  xvgr/xmgr file 
129 .BI "\-m" " rmsd.xpm" 
130 .B Output, Opt.
131  X PixMap compatible matrix file 
133 .BI "\-bin" " rmsd.dat" 
134 .B Output, Opt.
135  Generic data file 
137 .BI "\-bm" " bond.xpm" 
138 .B Output, Opt.
139  X PixMap compatible matrix file 
141 .SH OTHER OPTIONS
142 .BI "\-[no]h"  "no    "
143  Print help info and quit
145 .BI "\-[no]version"  "no    "
146  Print version info and quit
148 .BI "\-nice"  " int" " 19" 
149  Set the nicelevel
151 .BI "\-b"  " time" " 0     " 
152  First frame (ps) to read from trajectory
154 .BI "\-e"  " time" " 0     " 
155  Last frame (ps) to read from trajectory
157 .BI "\-dt"  " time" " 0     " 
158  Only use frame when t MOD dt = first time (ps)
160 .BI "\-tu"  " enum" " ps" 
161  Time unit: \fB fs\fR, \fB ps\fR, \fB ns\fR, \fB us\fR, \fB ms\fR or \fB s\fR
163 .BI "\-[no]w"  "no    "
164  View output \fB .xvg\fR, \fB .xpm\fR, \fB .eps\fR and \fB .pdb\fR files
166 .BI "\-xvg"  " enum" " xmgrace" 
167  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
169 .BI "\-what"  " enum" " rmsd" 
170  Structural difference measure: \fB rmsd\fR, \fB rho\fR or \fB rhosc\fR
172 .BI "\-[no]pbc"  "yes   "
173  PBC check
175 .BI "\-fit"  " enum" " rot+trans" 
176  Fit to reference structure: \fB rot+trans\fR, \fB translation\fR or \fB none\fR
178 .BI "\-prev"  " int" " 0" 
179  Compare with previous frame
181 .BI "\-[no]split"  "no    "
182  Split graph where time is zero
184 .BI "\-skip"  " int" " 1" 
185  Only write every nr\-th frame to matrix
187 .BI "\-skip2"  " int" " 1" 
188  Only write every nr\-th frame to matrix
190 .BI "\-max"  " real" " \-1    " 
191  Maximum level in comparison matrix
193 .BI "\-min"  " real" " \-1    " 
194  Minimum level in comparison matrix
196 .BI "\-bmax"  " real" " \-1    " 
197  Maximum level in bond angle matrix
199 .BI "\-bmin"  " real" " \-1    " 
200  Minimum level in bond angle matrix
202 .BI "\-[no]mw"  "yes   "
203  Use mass weighting for superposition
205 .BI "\-nlevels"  " int" " 80" 
206  Number of levels in the matrices
208 .BI "\-ng"  " int" " 1" 
209  Number of groups to compute RMS between
211 .SH SEE ALSO
212 .BR gromacs(7)
214 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.