updated FindCUDA to version from cmake 2.8.1 for CUDA 2.3 support
[gromacs/rigid-bodies.git] / man / man1 / g_rms.1
blob56859cd3e54ba90001c22b05e5ad215e57fc875e
1 .TH g_rms 1 "Thu 16 Oct 2008"
2 .SH NAME
3 g_rms - calculates rmsd's with a reference structure and rmsd matrices
5 .B VERSION 4.0
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 "-nice" " int "
21 .BI "-b" " time "
22 .BI "-e" " time "
23 .BI "-dt" " time "
24 .BI "-tu" " enum "
25 .BI "-[no]w" ""
26 .BI "-[no]xvgr" ""
27 .BI "-what" " enum "
28 .BI "-[no]pbc" ""
29 .BI "-fit" " enum "
30 .BI "-prev" " int "
31 .BI "-[no]split" ""
32 .BI "-skip" " int "
33 .BI "-skip2" " int "
34 .BI "-max" " real "
35 .BI "-min" " real "
36 .BI "-bmax" " real "
37 .BI "-bmin" " real "
38 .BI "-[no]mw" ""
39 .BI "-nlevels" " int "
40 .BI "-ng" " int "
41 .SH DESCRIPTION
42 g_rms compares two structures by computing the root mean square
43 deviation (RMSD), the size-independent 'rho' similarity parameter
44 (rho) or the scaled rho (rhosc), 
45 see Maiorov & Crippen, PROTEINS 
46 .B 22
47 , 273 (1995).
48 This is selected by 
49 .B -what
52 Each structure from a trajectory (
53 .B -f
54 ) is compared to a
55 reference structure. The reference structure
56 is taken from the structure file (
57 .B -s
61 With option 
62 .B -mir
63 also a comparison with the mirror image of
64 the reference structure is calculated.
65 This is useful as a reference for 'significant' values, see
66 Maiorov & Crippen, PROTEINS 
67 .B 22
68 , 273 (1995).
71 Option 
72 .B -prev
73 produces the comparison with a previous frame
74 the specified number of frames ago.
77 Option 
78 .B -m
79 produces a matrix in 
80 .B .xpm
81 format of
82 comparison values of each structure in the trajectory with respect to
83 each other structure. This file can be visualized with for instance
85 .B xv
86 and can be converted to postscript with 
87 .B xpm2ps
91 Option 
92 .B -fit
93 controls the least-squares fitting of
94 the structures on top of each other: complete fit (rotation and
95 translation), translation only, or no fitting at all.
98 Option 
99 .B -mw
100 controls whether mass weighting is done or not.
101 If you select the option (default) and 
102 supply a valid tpr file masses will be taken from there, 
103 otherwise the masses will be deduced from the atommass.dat file in
104 the GROMACS library directory. This is fine for proteins but not
105 necessarily for other molecules. A default mass of 12.011 amu (Carbon)
106 is assigned to unknown atoms. You can check whether this happend by
107 turning on the 
108 .B -debug
109 flag and inspecting the log file.
112 With 
113 .B -f2
114 , the 'other structures' are taken from a second
115 trajectory, this generates a comparison matrix of one trajectory
116 versus the other.
119 Option 
120 .B -bin
121 does a binary dump of the comparison matrix.
124 Option 
125 .B -bm
126 produces a matrix of average bond angle deviations
127 analogously to the 
128 .B -m
129 option. Only bonds between atoms in the
130 comparison group are considered.
131 .SH FILES
132 .BI "-s" " topol.tpr" 
133 .B Input
134  Structure+mass(db): tpr tpb tpa gro g96 pdb 
136 .BI "-f" " traj.xtc" 
137 .B Input
138  Trajectory: xtc trr trj gro g96 pdb cpt 
140 .BI "-f2" " traj.xtc" 
141 .B Input, Opt.
142  Trajectory: xtc trr trj gro g96 pdb cpt 
144 .BI "-n" " index.ndx" 
145 .B Input, Opt.
146  Index file 
148 .BI "-o" " rmsd.xvg" 
149 .B Output
150  xvgr/xmgr file 
152 .BI "-mir" " rmsdmir.xvg" 
153 .B Output, Opt.
154  xvgr/xmgr file 
156 .BI "-a" " avgrp.xvg" 
157 .B Output, Opt.
158  xvgr/xmgr file 
160 .BI "-dist" " rmsd-dist.xvg" 
161 .B Output, Opt.
162  xvgr/xmgr file 
164 .BI "-m" " rmsd.xpm" 
165 .B Output, Opt.
166  X PixMap compatible matrix file 
168 .BI "-bin" " rmsd.dat" 
169 .B Output, Opt.
170  Generic data file 
172 .BI "-bm" " bond.xpm" 
173 .B Output, Opt.
174  X PixMap compatible matrix file 
176 .SH OTHER OPTIONS
177 .BI "-[no]h"  "no    "
178  Print help info and quit
180 .BI "-nice"  " int" " 19" 
181  Set the nicelevel
183 .BI "-b"  " time" " 0     " 
184  First frame (ps) to read from trajectory
186 .BI "-e"  " time" " 0     " 
187  Last frame (ps) to read from trajectory
189 .BI "-dt"  " time" " 0     " 
190  Only use frame when t MOD dt = first time (ps)
192 .BI "-tu"  " enum" " ps" 
193  Time unit: 
194 .B ps
196 .B fs
198 .B ns
200 .B us
202 .B ms
203 or 
204 .B s
207 .BI "-[no]w"  "no    "
208  View output xvg, xpm, eps and pdb files
210 .BI "-[no]xvgr"  "yes   "
211  Add specific codes (legends etc.) in the output xvg files for the xmgrace program
213 .BI "-what"  " enum" " rmsd" 
214  Structural difference measure: 
215 .B rmsd
217 .B rho
218 or 
219 .B rhosc
222 .BI "-[no]pbc"  "yes   "
223  PBC check
225 .BI "-fit"  " enum" " rot+trans" 
226  Fit to reference structure: 
227 .B rot+trans
229 .B translation
230 or 
231 .B none
234 .BI "-prev"  " int" " 0" 
235  Compare with previous frame
237 .BI "-[no]split"  "no    "
238  Split graph where time is zero
240 .BI "-skip"  " int" " 1" 
241  Only write every nr-th frame to matrix
243 .BI "-skip2"  " int" " 1" 
244  Only write every nr-th frame to matrix
246 .BI "-max"  " real" " -1    " 
247  Maximum level in comparison matrix
249 .BI "-min"  " real" " -1    " 
250  Minimum level in comparison matrix
252 .BI "-bmax"  " real" " -1    " 
253  Maximum level in bond angle matrix
255 .BI "-bmin"  " real" " -1    " 
256  Minimum level in bond angle matrix
258 .BI "-[no]mw"  "yes   "
259  Use mass weighting for superposition
261 .BI "-nlevels"  " int" " 80" 
262  Number of levels in the matrices
264 .BI "-ng"  " int" " 1" 
265  Number of groups to compute RMS between