Fixed make_edi.c
[gromacs/rigid-bodies.git] / man / man1 / make_edi.1
bloba429ac1b8e7b7dcbb07c49e2a038be1410388009
1 .TH make_edi 1 "Thu 16 Oct 2008"
2 .SH NAME
3 make_edi - generate input files for essential dynamics sampling
5 .B VERSION 4.0
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 "-nice" " int "
17 .BI "-[no]xvgr" ""
18 .BI "-mon" " string "
19 .BI "-linfix" " string "
20 .BI "-linacc" " string "
21 .BI "-flood" " string "
22 .BI "-radfix" " string "
23 .BI "-radacc" " string "
24 .BI "-radcon" " string "
25 .BI "-outfrq" " int "
26 .BI "-slope" " real "
27 .BI "-maxedsteps" " int "
28 .BI "-deltaF0" " real "
29 .BI "-deltaF" " real "
30 .BI "-tau" " real "
31 .BI "-eqsteps" " int "
32 .BI "-Eflnull" " real "
33 .BI "-T" " real "
34 .BI "-alpha" " real "
35 .BI "-linstep" " string "
36 .BI "-accdir" " string "
37 .BI "-radstep" " real "
38 .BI "-[no]restrain" ""
39 .BI "-[no]hessian" ""
40 .BI "-[no]harmonic" ""
41 .SH DESCRIPTION
43 .B make_edi
44 generates an essential dynamics (ED) sampling input file to be used with mdrun
45 based on eigenvectors of a covariance matrix (
46 .B g_covar
47 ) or from a
48 normal modes anaysis (
49 .B g_nmeig
51 ED sampling can be used to manipulate the position along collective coordinates
52 (eigenvectors) of (biological) macromolecules during a simulation. Particularly,
53 it may be used to enhance the sampling efficiency of MD simulations by stimulating
54 the system to explore new regions along these collective coordinates. A number
55 of different algorithms are implemented to drive the system along the eigenvectors
57 .B -linfix
58
59 .B -linacc
60
61 .B -radfix
62
63 .B -radacc
64
65 .B -radcon
67 to keep the position along a certain (set of) coordinate(s) fixed (
68 .B -linfix
70 or to only monitor the projections of the positions onto
71 these coordinates (
72 .B -mon
75 References:
77 A. Amadei, A.B.M. Linssen, B.L. de Groot, D.M.F. van Aalten and 
78 H.J.C. Berendsen; An efficient method for sampling the essential subspace 
79 of proteins., J. Biomol. Struct. Dyn. 13:615-626 (1996)
81 B.L. de Groot, A. Amadei, D.M.F. van Aalten and H.J.C. Berendsen; 
82 Towards an exhaustive sampling of the configurational spaces of the 
83 two forms of the peptide hormone guanylin,J. Biomol. Struct. Dyn. 13 : 741-751 (1996)
85 B.L. de Groot, A.Amadei, R.M. Scheek, N.A.J. van Nuland and H.J.C. Berendsen; 
86 An extended sampling of the configurational space of HPr from E. coli
87 PROTEINS: Struct. Funct. Gen. 26: 314-322 (1996)
90 You will be prompted for one or more index groups that correspond to the eigenvectors,
91 reference structure, target positions, etc.
95 .B -mon
96 : monitor projections of the coordinates onto selected eigenvectors.
100 .B -linfix
101 : perform fixed-step linear expansion along selected eigenvectors.
105 .B -linacc
106 : perform acceptance linear expansion along selected eigenvectors.
107 (steps in the desired directions will be accepted, others will be rejected).
111 .B -radfix
112 : perform fixed-step radius expansion along selected eigenvectors.
116 .B -radacc
117 : perform acceptance radius expansion along selected eigenvectors.
118 (steps in the desired direction will be accepted, others will be rejected).
119 Note: by default the starting MD structure will be taken as origin of the first
120 expansion cycle for radius expansion. If 
121 .B -ori
122 is specified, you will be able
123 to read in a structure file that defines an external origin.
126 .B -radcon
127 : perform acceptance radius contraction along selected eigenvectors
128 towards a target structure specified with 
129 .B -tar
132 NOTE: each eigenvector can be selected only once. 
135 .B -outfrq
136 : frequency (in steps) of writing out projections etc. to .edo file
140 .B -slope
141 : minimal slope in acceptance radius expansion. A new expansion
142 cycle will be started if the spontaneous increase of the radius (in nm/step)
143 is less than the value specified.
146 .B -maxedsteps
147 : maximum number of steps per cycle in radius expansion
148 before a new cycle is started.
150 Note on the parallel implementation: since ED sampling is a 'global' thing
151 (collective coordinates etc.), at least on the 'protein' side, ED sampling
152 is not very parallel-friendly from an implentation point of view. Because
153 parallel ED requires much extra communication, expect the performance to be
154 lower as in a free MD simulation, especially on a large number of nodes. 
157 All output of mdrun (specify with -eo) is written to a .edo file. In the output
158 file, per OUTFRQ step the following information is present: 
161 * the step number
163 * the number of the ED dataset. (Note that you can impose multiple ED constraints in
164 a single simulation - on different molecules e.g. - if several .edi files were concatenated
165 first. The constraints are applied in the order they appear in the .edi file.) 
167 * RMSD (for atoms involved in fitting prior to calculating the ED constraints)
169 * projections of the positions onto selected eigenvectors
176 FLOODING:
179 with -flood you can specify which eigenvectors are used to compute a flooding potential,
180 which will lead to extra forces expelling the structure out of the region described
181 by the covariance matrix. If you switch -restrain the potential is inverted and the structure
182 is kept in that region.
186 The origin is normally the average structure stored in the eigvec.trr file.
187 It can be changed with -ori to an arbitrary position in configurational space.
188 With -tau, -deltaF0 and -Eflnull you control the flooding behaviour.
189 Efl is the flooding strength, it is updated according to the rule of adaptive flooding.
190 Tau is the time constant of adaptive flooding, high tau means slow adaption (i.e. growth). 
191 DeltaF0 is the flooding strength you want to reach after tau ps of simulation.
192 To use constant Efl set -tau to zero.
196 -alpha is a fudge parameter to control the width of the flooding potential. A value of 2 has been found
197 to give good results for most standard cases in flooding of proteins.
198 Alpha basically accounts for incomplete sampling, if you sampled further the width of the ensemble would
199 increase, this is mimicked by alpha1.
200 For restraining alpha1 can give you smaller width in the restraining potential.
204 RESTART and FLOODING:
205 If you want to restart a crashed flooding simulation please find the values deltaF and Efl in
206 the output file and manually put them into the .edi file under DELTA_F0 and EFL_NULL.
207 .SH FILES
208 .BI "-f" " eigenvec.trr" 
209 .B Input
210  Full precision trajectory: trr trj cpt 
212 .BI "-eig" " eigenval.xvg" 
213 .B Input, Opt.
214  xvgr/xmgr file 
216 .BI "-s" " topol.tpr" 
217 .B Input
218  Structure+mass(db): tpr tpb tpa gro g96 pdb 
220 .BI "-n" " index.ndx" 
221 .B Input, Opt.
222  Index file 
224 .BI "-tar" " target.gro" 
225 .B Input, Opt.
226  Structure file: gro g96 pdb tpr tpb tpa 
228 .BI "-ori" " origin.gro" 
229 .B Input, Opt.
230  Structure file: gro g96 pdb tpr tpb tpa 
232 .BI "-o" " sam.edi" 
233 .B Output
234  ED sampling input 
236 .SH OTHER OPTIONS
237 .BI "-[no]h"  "no    "
238  Print help info and quit
240 .BI "-nice"  " int" " 0" 
241  Set the nicelevel
243 .BI "-[no]xvgr"  "yes   "
244  Add specific codes (legends etc.) in the output xvg files for the xmgrace program
246 .BI "-mon"  " string" " " 
247  Indices of eigenvectors for projections of x (e.g. 1,2-5,9) or 1-100:10 means 1 11 21 31 ... 91
249 .BI "-linfix"  " string" " " 
250  Indices of eigenvectors for fixed increment linear sampling
252 .BI "-linacc"  " string" " " 
253  Indices of eigenvectors for acceptance linear sampling
255 .BI "-flood"  " string" " " 
256  Indices of eigenvectors for flooding
258 .BI "-radfix"  " string" " " 
259  Indices of eigenvectors for fixed increment radius expansion
261 .BI "-radacc"  " string" " " 
262  Indices of eigenvectors for acceptance radius expansion
264 .BI "-radcon"  " string" " " 
265  Indices of eigenvectors for acceptance radius contraction
267 .BI "-outfrq"  " int" " 100" 
268  Freqency (in steps) of writing output in .edo file
270 .BI "-slope"  " real" " 0     " 
271  Minimal slope in acceptance radius expansion
273 .BI "-maxedsteps"  " int" " 0" 
274  Max nr of steps per cycle
276 .BI "-deltaF0"  " real" " 150   " 
277  Target destabilization energy  - used for flooding
279 .BI "-deltaF"  " real" " 0     " 
280  Start deltaF with this parameter - default 0, i.e. nonzero values only needed for restart
282 .BI "-tau"  " real" " 0.1   " 
283  Coupling constant for adaption of flooding strength according to deltaF0, 0 = infinity i.e. constant flooding strength
285 .BI "-eqsteps"  " int" " 0" 
286  Number of steps to run without any perturbations 
288 .BI "-Eflnull"  " real" " 0     " 
289  This is the starting value of the flooding strength. The flooding strength is updated according to the adaptive flooding scheme. To use a constant flooding strength use -tau 0. 
291 .BI "-T"  " real" " 300   " 
292  T is temperature, the value is needed if you want to do flooding 
294 .BI "-alpha"  " real" " 1     " 
295  Scale width of gaussian flooding potential with alpha2 
297 .BI "-linstep"  " string" " " 
298  Stepsizes (nm/step) for fixed increment linear sampling (put in quotes! "1.0 2.3 5.1 -3.1")
300 .BI "-accdir"  " string" " " 
301  Directions for acceptance linear sampling - only sign counts! (put in quotes! "-1 +1 -1.1")
303 .BI "-radstep"  " real" " 0     " 
304  Stepsize (nm/step) for fixed increment radius expansion
306 .BI "-[no]restrain"  "no    "
307  Use the flooding potential with inverted sign - effects as quasiharmonic restraining potential
309 .BI "-[no]hessian"  "no    "
310  The eigenvectors and eigenvalues are from a Hessian matrix
312 .BI "-[no]harmonic"  "no    "
313  The eigenvalues are interpreted as spring constant