updated FindCUDA to version from cmake 2.8.1 for CUDA 2.3 support
[gromacs/rigid-bodies.git] / man / man1 / gmxcheck.1
blobd0543ee30082bd8249ec9b04a4fd741330fcec6b
1 .TH gmxcheck 1 "Thu 16 Oct 2008"
2 .SH NAME
3 gmxcheck - checks and compares files
5 .B VERSION 4.0
6 .SH SYNOPSIS
7 \f3gmxcheck\fP
8 .BI "-f" " traj.xtc "
9 .BI "-f2" " traj.xtc "
10 .BI "-s1" " top1.tpr "
11 .BI "-s2" " top2.tpr "
12 .BI "-c" " topol.tpr "
13 .BI "-e" " ener.edr "
14 .BI "-e2" " ener2.edr "
15 .BI "-n" " index.ndx "
16 .BI "-m" " doc.tex "
17 .BI "-[no]h" ""
18 .BI "-nice" " int "
19 .BI "-vdwfac" " real "
20 .BI "-bonlo" " real "
21 .BI "-bonhi" " real "
22 .BI "-tol" " real "
23 .BI "-[no]ab" ""
24 .BI "-lastener" " string "
25 .SH DESCRIPTION
26 gmxcheck reads a trajectory (
27 .B .trj
28
29 .B .trr
30 or 
32 .B .xtc
33 ), an energy file (
34 .B .ene
35 or 
36 .B .edr
38 or an index file (
39 .B .ndx
41 and prints out useful information about them.
44 Option 
45 .B -c
46 checks for presence of coordinates,
47 velocities and box in the file, for close contacts (smaller than
49 .B -vdwfac
50 and not bonded, i.e. not between 
51 .B -bonlo
53 and 
54 .B -bonhi
55 , all relative to the sum of both Van der Waals
56 radii) and atoms outside the box (these may occur often and are
57 no problem). If velocities are present, an estimated temperature
58 will be calculated from them.
61 If an index file is given it's contents will be sumamrized.
64 If both a trajectory and a tpr file are given (with 
65 .B -s1
67 the program will check whether the bond lengths defined in the tpr
68 file are indeed correct in the trajectory. If not you may have
69 non-matching files due to e.g. deshuffling or due to problems with
70 virtual sites. With these flags, gmxcheck provides a quick check for such problems.
72 The program can compare run two input (
73 .B .tpr
74
75 .B .tpb
78 .B .tpa
79 ) files
80 when both 
81 .B -s1
82 and 
83 .B -s2
84 are supplied.
85 Similarly a pair of trajectory files can be compared (using the 
86 .B -f2
88 option), or a pair of energy files (using the 
89 .B -e2
90 option).
93 For free energy simulations the A and B state topology from one
94 run input file can be compared with options 
95 .B -s1
96 and 
97 .B -ab
101 In case the 
102 .B -m
103 flag is given a LaTeX file will be written
104 consisting a rough outline for a methods section for a paper.
105 .SH FILES
106 .BI "-f" " traj.xtc" 
107 .B Input, Opt.
108  Trajectory: xtc trr trj gro g96 pdb cpt 
110 .BI "-f2" " traj.xtc" 
111 .B Input, Opt.
112  Trajectory: xtc trr trj gro g96 pdb cpt 
114 .BI "-s1" " top1.tpr" 
115 .B Input, Opt.
116  Run input file: tpr tpb tpa 
118 .BI "-s2" " top2.tpr" 
119 .B Input, Opt.
120  Run input file: tpr tpb tpa 
122 .BI "-c" " topol.tpr" 
123 .B Input, Opt.
124  Structure+mass(db): tpr tpb tpa gro g96 pdb 
126 .BI "-e" " ener.edr" 
127 .B Input, Opt.
128  Energy file: edr ene 
130 .BI "-e2" " ener2.edr" 
131 .B Input, Opt.
132  Energy file: edr ene 
134 .BI "-n" " index.ndx" 
135 .B Input, Opt.
136  Index file 
138 .BI "-m" " doc.tex" 
139 .B Output, Opt.
140  LaTeX file 
142 .SH OTHER OPTIONS
143 .BI "-[no]h"  "no    "
144  Print help info and quit
146 .BI "-nice"  " int" " 0" 
147  Set the nicelevel
149 .BI "-vdwfac"  " real" " 0.8   " 
150  Fraction of sum of VdW radii used as warning cutoff
152 .BI "-bonlo"  " real" " 0.4   " 
153  Min. fract. of sum of VdW radii for bonded atoms
155 .BI "-bonhi"  " real" " 0.7   " 
156  Max. fract. of sum of VdW radii for bonded atoms
158 .BI "-tol"  " real" " 0.001 " 
159  Relative tolerance for comparing real values defined as 2*(a-b)/(|a|+|b|)
161 .BI "-[no]ab"  "no    "
162  Compare the A and B topology from one file
164 .BI "-lastener"  " string" " " 
165  Last energy term to compare (if not given all are tested). It makes sense to go up until the Pressure.