Fixed make_edi.c
[gromacs/rigid-bodies.git] / man / man1 / grompp.1
blobf029809a5260d5c3ddc9d525fb3596ac9d7f2aca
1 .TH grompp 1 "Thu 16 Oct 2008"
2 .SH NAME
3 grompp - makes a run input file
5 .B VERSION 4.0
6 .SH SYNOPSIS
7 \f3grompp\fP
8 .BI "-f" " grompp.mdp "
9 .BI "-po" " mdout.mdp "
10 .BI "-c" " conf.gro "
11 .BI "-r" " conf.gro "
12 .BI "-rb" " conf.gro "
13 .BI "-n" " index.ndx "
14 .BI "-p" " topol.top "
15 .BI "-pp" " processed.top "
16 .BI "-o" " topol.tpr "
17 .BI "-t" " traj.trr "
18 .BI "-e" " ener.edr "
19 .BI "-[no]h" ""
20 .BI "-nice" " int "
21 .BI "-[no]v" ""
22 .BI "-time" " real "
23 .BI "-[no]rmvsbds" ""
24 .BI "-maxwarn" " int "
25 .BI "-[no]zero" ""
26 .BI "-[no]renum" ""
27 .SH DESCRIPTION
28 The gromacs preprocessor
29 reads a molecular topology file, checks the validity of the
30 file, expands the topology from a molecular description to an atomic
31 description. The topology file contains information about
32 molecule types and the number of molecules, the preprocessor
33 copies each molecule as needed. 
34 There is no limitation on the number of molecule types. 
35 Bonds and bond-angles can be converted into constraints, separately
36 for hydrogens and heavy atoms.
37 Then a coordinate file is read and velocities can be generated
38 from a Maxwellian distribution if requested.
39 grompp also reads parameters for the mdrun 
40 (eg. number of MD steps, time step, cut-off), and others such as
41 NEMD parameters, which are corrected so that the net acceleration
42 is zero.
43 Eventually a binary file is produced that can serve as the sole input
44 file for the MD program.
47 grompp uses the atom names from the topology file. The atom names
48 in the coordinate file (option 
49 .B -c
50 ) are only read to generate
51 warnings when they do not match the atom names in the topology.
52 Note that the atom names are irrelevant for the simulation as
53 only the atom types are used for generating interaction parameters.
56 grompp calls a preprocessor to resolve includes, macros 
57 etcetera. By default we use the cpp in your path. To specify a different macro-preprocessor (e.g. m4) or alternative location
58 you can put a line in your parameter file specifying the path
59 to that program. Specifying 
60 .B -pp
61 will get the pre-processed
62 topology file written out.
65 If your system does not have a c-preprocessor, you can still
66 use grompp, but you do not have access to the features 
67 from the cpp. Command line options to the c-preprocessor can be given
68 in the 
69 .B .mdp
70 file. See your local manual (man cpp).
73 When using position restraints a file with restraint coordinates
74 can be supplied with 
75 .B -r
76 , otherwise restraining will be done
77 with respect to the conformation from the 
78 .B -c
79 option.
80 For free energy calculation the the coordinates for the B topology
81 can be supplied with 
82 .B -rb
83 , otherwise they will be equal to
84 those of the A topology.
87 Starting coordinates can be read from trajectory with 
88 .B -t
90 The last frame with coordinates and velocities will be read,
91 unless the 
92 .B -time
93 option is used.
94 Note that these velocities will not be used when 
95 .B gen_vel = yes
97 in your 
98 .B .mdp
99 file. An energy file can be supplied with
101 .B -e
102 to have exact restarts when using pressure and/or
103 Nose-Hoover temperature coupling. For an exact restart do not forget
104 to turn off velocity generation and turn on unconstrained starting
105 when constraints are present in the system.
106 If you want to continue a crashed run, it is
107 easier to use 
108 .B tpbconv
112 Using the 
113 .B -morse
114 option grompp can convert the harmonic bonds
115 in your topology to morse potentials. This makes it possible to break
116 bonds. For this option to work you need an extra file in your $GMXLIB
117 with dissociation energy. Use the -debug option to get more information
118 on the workings of this option (look for MORSE in the grompp.log file
119 using less or something like that).
122 By default all bonded interactions which have constant energy due to
123 virtual site constructions will be removed. If this constant energy is
124 not zero, this will result in a shift in the total energy. All bonded
125 interactions can be kept by turning off 
126 .B -rmvsbds
127 . Additionally,
128 all constraints for distances which will be constant anyway because
129 of virtual site constructions will be removed. If any constraints remain
130 which involve virtual sites, a fatal error will result.
132 To verify your run input file, please make notice of all warnings
133 on the screen, and correct where necessary. Do also look at the contents
134 of the 
135 .B mdout.mdp
136 file, this contains comment lines, as well as
137 the input that 
138 .B grompp
139 has read. If in doubt you can start grompp
140 with the 
141 .B -debug
142 option which will give you more information
143 in a file called grompp.log (along with real debug info). Finally, you
144 can see the contents of the run input file with the 
145 .B gmxdump
147 program.
148 .SH FILES
149 .BI "-f" " grompp.mdp" 
150 .B Input, Opt.
151  grompp input file with MD parameters 
153 .BI "-po" " mdout.mdp" 
154 .B Output
155  grompp input file with MD parameters 
157 .BI "-c" " conf.gro" 
158 .B Input
159  Structure file: gro g96 pdb tpr tpb tpa 
161 .BI "-r" " conf.gro" 
162 .B Input, Opt.
163  Structure file: gro g96 pdb tpr tpb tpa 
165 .BI "-rb" " conf.gro" 
166 .B Input, Opt.
167  Structure file: gro g96 pdb tpr tpb tpa 
169 .BI "-n" " index.ndx" 
170 .B Input, Opt.
171  Index file 
173 .BI "-p" " topol.top" 
174 .B Input
175  Topology file 
177 .BI "-pp" " processed.top" 
178 .B Output, Opt.
179  Topology file 
181 .BI "-o" " topol.tpr" 
182 .B Output
183  Run input file: tpr tpb tpa 
185 .BI "-t" " traj.trr" 
186 .B Input, Opt.
187  Full precision trajectory: trr trj cpt 
189 .BI "-e" " ener.edr" 
190 .B Input, Opt.
191  Energy file: edr ene 
193 .SH OTHER OPTIONS
194 .BI "-[no]h"  "no    "
195  Print help info and quit
197 .BI "-nice"  " int" " 0" 
198  Set the nicelevel
200 .BI "-[no]v"  "yes   "
201  Be loud and noisy
203 .BI "-time"  " real" " -1    " 
204  Take frame at or first after this time.
206 .BI "-[no]rmvsbds"  "yes   "
207  Remove constant bonded interactions with virtual sites
209 .BI "-maxwarn"  " int" " 0" 
210  Number of allowed warnings during input processing
212 .BI "-[no]zero"  "no    "
213  Set parameters for bonded interactions without defaults to zero instead of generating an error
215 .BI "-[no]renum"  "yes   "
216  Renumber atomtypes and minimize number of atomtypes