New entry
[gromacs/rigid-bodies.git] / man / man1 / make_edi.1
blob28c40cf727dcca34d5bfbe0166da46507052fa90
1 .TH make_edi 1 "Mon 4 Apr 2011" "" "GROMACS suite, VERSION 4.5.4-dev-20110404-bc5695c"
2 .SH NAME
3 make_edi - generate input files for essential dynamics sampling
5 .B VERSION 4.5.4-dev-20110404-bc5695c
6 .SH SYNOPSIS
7 \f3make_edi\fP
8 .BI "\-f" " eigenvec.trr "
9 .BI "\-eig" " eigenval.xvg "
10 .BI "\-s" " topol.tpr "
11 .BI "\-n" " index.ndx "
12 .BI "\-tar" " target.gro "
13 .BI "\-ori" " origin.gro "
14 .BI "\-o" " sam.edi "
15 .BI "\-[no]h" ""
16 .BI "\-[no]version" ""
17 .BI "\-nice" " int "
18 .BI "\-xvg" " enum "
19 .BI "\-mon" " string "
20 .BI "\-linfix" " string "
21 .BI "\-linacc" " string "
22 .BI "\-radfix" " string "
23 .BI "\-radacc" " string "
24 .BI "\-radcon" " string "
25 .BI "\-flood" " string "
26 .BI "\-outfrq" " int "
27 .BI "\-slope" " real "
28 .BI "\-linstep" " string "
29 .BI "\-accdir" " string "
30 .BI "\-radstep" " real "
31 .BI "\-maxedsteps" " int "
32 .BI "\-eqsteps" " int "
33 .BI "\-deltaF0" " real "
34 .BI "\-deltaF" " real "
35 .BI "\-tau" " real "
36 .BI "\-Eflnull" " real "
37 .BI "\-T" " real "
38 .BI "\-alpha" " real "
39 .BI "\-[no]restrain" ""
40 .BI "\-[no]hessian" ""
41 .BI "\-[no]harmonic" ""
42 .BI "\-constF" " string "
43 .SH DESCRIPTION
44 \&\fB make_edi\fR generates an essential dynamics (ED) sampling input file to be used with \fB mdrun\fR
45 \&based on eigenvectors of a covariance matrix (\fB g_covar\fR) or from a
46 \&normal modes anaysis (\fB g_nmeig\fR).
47 \&ED sampling can be used to manipulate the position along collective coordinates
48 \&(eigenvectors) of (biological) macromolecules during a simulation. Particularly,
49 \&it may be used to enhance the sampling efficiency of MD simulations by stimulating
50 \&the system to explore new regions along these collective coordinates. A number
51 \&of different algorithms are implemented to drive the system along the eigenvectors
52 \&(\fB \-linfix\fR, \fB \-linacc\fR, \fB \-radfix\fR, \fB \-radacc\fR, \fB \-radcon\fR),
53 \&to keep the position along a certain (set of) coordinate(s) fixed (\fB \-linfix\fR),
54 \&or to only monitor the projections of the positions onto
55 \&these coordinates (\fB \-mon\fR).
58 \&References:
60 \&A. Amadei, A.B.M. Linssen, B.L. de Groot, D.M.F. van Aalten and 
61 \&H.J.C. Berendsen; An efficient method for sampling the essential subspace 
62 \&of proteins., J. Biomol. Struct. Dyn. 13:615\-626 (1996)
64 \&B.L. de Groot, A. Amadei, D.M.F. van Aalten and H.J.C. Berendsen; 
65 \&Towards an exhaustive sampling of the configurational spaces of the 
66 \&two forms of the peptide hormone guanylin,
67 \&J. Biomol. Struct. Dyn. 13 : 741\-751 (1996)
69 \&B.L. de Groot, A.Amadei, R.M. Scheek, N.A.J. van Nuland and H.J.C. Berendsen; 
70 \&An extended sampling of the configurational space of HPr from E. coli
71 \&Proteins: Struct. Funct. Gen. 26: 314\-322 (1996)
74 You will be prompted for one or more index groups that correspond to the eigenvectors,
75 \&reference structure, target positions, etc.
78 \&\fB \-mon\fR: monitor projections of the coordinates onto selected eigenvectors.
81 \&\fB \-linfix\fR: perform fixed\-step linear expansion along selected eigenvectors.
84 \&\fB \-linacc\fR: perform acceptance linear expansion along selected eigenvectors.
85 \&(steps in the desired directions will be accepted, others will be rejected).
88 \&\fB \-radfix\fR: perform fixed\-step radius expansion along selected eigenvectors.
91 \&\fB \-radacc\fR: perform acceptance radius expansion along selected eigenvectors.
92 \&(steps in the desired direction will be accepted, others will be rejected).
93 \&\fB Note:\fR by default the starting MD structure will be taken as origin of the first
94 \&expansion cycle for radius expansion. If \fB \-ori\fR is specified, you will be able
95 \&to read in a structure file that defines an external origin.
98 \&\fB \-radcon\fR: perform acceptance radius contraction along selected eigenvectors
99 \&towards a target structure specified with \fB \-tar\fR.
102 \&NOTE: each eigenvector can be selected only once. 
105 \&\fB \-outfrq\fR: frequency (in steps) of writing out projections etc. to \fB .edo\fR file
108 \&\fB \-slope\fR: minimal slope in acceptance radius expansion. A new expansion
109 \&cycle will be started if the spontaneous increase of the radius (in nm/step)
110 \&is less than the value specified.
113 \&\fB \-maxedsteps\fR: maximum number of steps per cycle in radius expansion
114 \&before a new cycle is started.
117 \&Note on the parallel implementation: since ED sampling is a 'global' thing
118 \&(collective coordinates etc.), at least on the 'protein' side, ED sampling
119 \&is not very parallel\-friendly from an implentation point of view. Because
120 \&parallel ED requires some extra communication, expect the performance to be
121 \&lower as in a free MD simulation, especially on a large number of nodes. 
124 \&All output of \fB mdrun\fR (specify with \fB \-eo\fR) is written to a .edo file. In the output
125 \&file, per OUTFRQ step the following information is present: 
128 \&\fB *\fR the step number
130 \&\fB *\fR the number of the ED dataset. (\fB Note\fR that you can impose multiple ED constraints in
131 \&a single simulation (on different molecules) if several \fB .edi\fR files were concatenated
132 \&first. The constraints are applied in the order they appear in the \fB .edi\fR file.) 
134 \&\fB *\fR RMSD (for atoms involved in fitting prior to calculating the ED constraints)
136 \&* projections of the positions onto selected eigenvectors
143 \&FLOODING:
146 \&with \fB \-flood\fR, you can specify which eigenvectors are used to compute a flooding potential,
147 \&which will lead to extra forces expelling the structure out of the region described
148 \&by the covariance matrix. If you switch \-restrain the potential is inverted and the structure
149 \&is kept in that region.
153 \&The origin is normally the average structure stored in the \fB eigvec.trr\fR file.
154 \&It can be changed with \fB \-ori\fR to an arbitrary position in configurational space.
155 \&With \fB \-tau\fR, \fB \-deltaF0\fR, and \fB \-Eflnull\fR you control the flooding behaviour.
156 \&Efl is the flooding strength, it is updated according to the rule of adaptive flooding.
157 \&Tau is the time constant of adaptive flooding, high tau means slow adaption (i.e. growth). 
158 \&DeltaF0 is the flooding strength you want to reach after tau ps of simulation.
159 \&To use constant Efl set \fB \-tau\fR to zero.
163 \&\fB \-alpha\fR is a fudge parameter to control the width of the flooding potential. A value of 2 has been found
164 \&to give good results for most standard cases in flooding of proteins.
165 \&alpha basically accounts for incomplete sampling, if you sampled further the width of the ensemble would
166 \&increase, this is mimicked by alpha  1.
167 \&For restraining, alpha  1 can give you smaller width in the restraining potential.
171 \&RESTART and FLOODING:
172 \&If you want to restart a crashed flooding simulation please find the values deltaF and Efl in
173 \&the output file and manually put them into the \fB .edi\fR file under DELTA_F0 and EFL_NULL.
174 .SH FILES
175 .BI "\-f" " eigenvec.trr" 
176 .B Input
177  Full precision trajectory: trr trj cpt 
179 .BI "\-eig" " eigenval.xvg" 
180 .B Input, Opt.
181  xvgr/xmgr file 
183 .BI "\-s" " topol.tpr" 
184 .B Input
185  Structure+mass(db): tpr tpb tpa gro g96 pdb 
187 .BI "\-n" " index.ndx" 
188 .B Input, Opt.
189  Index file 
191 .BI "\-tar" " target.gro" 
192 .B Input, Opt.
193  Structure file: gro g96 pdb tpr etc. 
195 .BI "\-ori" " origin.gro" 
196 .B Input, Opt.
197  Structure file: gro g96 pdb tpr etc. 
199 .BI "\-o" " sam.edi" 
200 .B Output
201  ED sampling input 
203 .SH OTHER OPTIONS
204 .BI "\-[no]h"  "no    "
205  Print help info and quit
207 .BI "\-[no]version"  "no    "
208  Print version info and quit
210 .BI "\-nice"  " int" " 0" 
211  Set the nicelevel
213 .BI "\-xvg"  " enum" " xmgrace" 
214  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
216 .BI "\-mon"  " string" " " 
217  Indices of eigenvectors for projections of x (e.g. 1,2\-5,9) or 1\-100:10 means 1 11 21 31 ... 91
219 .BI "\-linfix"  " string" " " 
220  Indices of eigenvectors for fixed increment linear sampling
222 .BI "\-linacc"  " string" " " 
223  Indices of eigenvectors for acceptance linear sampling
225 .BI "\-radfix"  " string" " " 
226  Indices of eigenvectors for fixed increment radius expansion
228 .BI "\-radacc"  " string" " " 
229  Indices of eigenvectors for acceptance radius expansion
231 .BI "\-radcon"  " string" " " 
232  Indices of eigenvectors for acceptance radius contraction
234 .BI "\-flood"  " string" " " 
235  Indices of eigenvectors for flooding
237 .BI "\-outfrq"  " int" " 100" 
238  Freqency (in steps) of writing output in \fB .edo\fR file
240 .BI "\-slope"  " real" " 0     " 
241  Minimal slope in acceptance radius expansion
243 .BI "\-linstep"  " string" " " 
244  Stepsizes (nm/step) for fixed increment linear sampling (put in quotes! "1.0 2.3 5.1 \-3.1")
246 .BI "\-accdir"  " string" " " 
247  Directions for acceptance linear sampling \- only sign counts! (put in quotes! "\-1 +1 \-1.1")
249 .BI "\-radstep"  " real" " 0     " 
250  Stepsize (nm/step) for fixed increment radius expansion
252 .BI "\-maxedsteps"  " int" " 0" 
253  Maximum number of steps per cycle
255 .BI "\-eqsteps"  " int" " 0" 
256  Number of steps to run without any perturbations 
258 .BI "\-deltaF0"  " real" " 150   " 
259  Target destabilization energy for flooding
261 .BI "\-deltaF"  " real" " 0     " 
262  Start deltaF with this parameter \- default 0, nonzero values only needed for restart
264 .BI "\-tau"  " real" " 0.1   " 
265  Coupling constant for adaption of flooding strength according to deltaF0, 0 = infinity i.e. constant flooding strength
267 .BI "\-Eflnull"  " real" " 0     " 
268  The starting value of the flooding strength. The flooding strength is updated according to the adaptive flooding scheme. For a constant flooding strength use \fB \-tau\fR 0. 
270 .BI "\-T"  " real" " 300   " 
271  T is temperature, the value is needed if you want to do flooding 
273 .BI "\-alpha"  " real" " 1     " 
274  Scale width of gaussian flooding potential with alpha2 
276 .BI "\-[no]restrain"  "no    "
277  Use the flooding potential with inverted sign \- effects as quasiharmonic restraining potential
279 .BI "\-[no]hessian"  "no    "
280  The eigenvectors and eigenvalues are from a Hessian matrix
282 .BI "\-[no]harmonic"  "no    "
283  The eigenvalues are interpreted as spring constant
285 .BI "\-constF"  " string" " " 
286  Constant force flooding: manually set the forces for the eigenvectors selected with \-flood (put in quotes! "1.0 2.3 5.1 \-3.1"). No other flooding parameters are needed when specifying the forces directly.
288 .SH SEE ALSO
289 .BR gromacs(7)
291 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.