Almost working now! not vv for average kinetic energy, but about to try something.
[gromacs.git] / man / man1 / editconf.1
blob4874062a12ba9c4905799828f65e86820fd57cad
1 .TH editconf 1 "Thu 16 Oct 2008"
2 .SH NAME
3 editconf - edits the box and writes subgroups 
5 .B VERSION 4.0
6 .SH SYNOPSIS
7 \f3editconf\fP
8 .BI "-f" " conf.gro "
9 .BI "-n" " index.ndx "
10 .BI "-o" " out.gro "
11 .BI "-mead" " mead.pqr "
12 .BI "-bf" " bfact.dat "
13 .BI "-[no]h" ""
14 .BI "-nice" " int "
15 .BI "-[no]w" ""
16 .BI "-[no]ndef" ""
17 .BI "-bt" " enum "
18 .BI "-box" " vector "
19 .BI "-angles" " vector "
20 .BI "-d" " real "
21 .BI "-[no]c" ""
22 .BI "-center" " vector "
23 .BI "-translate" " vector "
24 .BI "-rotate" " vector "
25 .BI "-[no]princ" ""
26 .BI "-scale" " vector "
27 .BI "-density" " real "
28 .BI "-[no]pbc" ""
29 .BI "-[no]grasp" ""
30 .BI "-rvdw" " real "
31 .BI "-sig56" " real "
32 .BI "-[no]vdwread" ""
33 .BI "-[no]atom" ""
34 .BI "-[no]legend" ""
35 .BI "-label" " string "
36 .SH DESCRIPTION
37 editconf converts generic structure format to 
38 .B .gro
39
40 .B .g96
42 or 
43 .B .pdb
48 The box can be modified with options 
49 .B -box
50
51 .B -d
52 and
54 .B -angles
55 . Both 
56 .B -box
57 and 
58 .B -d
60 will center the system in the box.
64 Option 
65 .B -bt
66 determines the box type: 
67 .B triclinic
68 is a
69 triclinic box, 
70 .B cubic
71 is a rectangular box with all sides equal
73 .B dodecahedron
74 represents a rhombic dodecahedron and 
75 .B octahedron
76 is a truncated octahedron.
77 The last two are special cases of a triclinic box.
78 The length of the three box vectors of the truncated octahedron is the
79 shortest distance between two opposite hexagons.
80 The volume of a dodecahedron is 0.71 and that of a truncated octahedron
81 is 0.77 of that of a cubic box with the same periodic image distance.
85 Option 
86 .B -box
87 requires only
88 one value for a cubic box, dodecahedron and a truncated octahedron.
92 With 
93 .B -d
94 and a 
95 .B triclinic
96 box the size of the system in the x, y
97 and z directions is used. With 
98 .B -d
99 and 
100 .B cubic
103 .B dodecahedron
104 or 
105 .B octahedron
106 boxes, the dimensions are set
107 to the diameter of the system (largest distance between atoms) plus twice
108 the specified distance.
112 Option 
113 .B -angles
114 is only meaningful with option 
115 .B -box
117 a triclinic box and can not be used with option 
118 .B -d
123 When 
124 .B -n
125 or 
126 .B -ndef
127 is set, a group
128 can be selected for calculating the size and the geometric center,
129 otherwise the whole system is used.
134 .B -rotate
135 rotates the coordinates and velocities.
140 .B -princ
141 aligns the principal axes of the system along the
142 coordinate axes, this may allow you to decrease the box volume,
143 but beware that molecules can rotate significantly in a nanosecond.
147 Scaling is applied before any of the other operations are
148 performed. Boxes and coordinates can be scaled to give a certain density (option
150 .B -density
151 ). Note that this may be inaccurate in case a gro
152 file is given as input. A special feature of the scaling option, when the
153 factor -1 is given in one dimension, one obtains a mirror image,
154 mirrored in one of the plains, when one uses -1 in three dimensions
155 a point-mirror image is obtained.
158 Groups are selected after all operations have been applied.
161 Periodicity can be removed in a crude manner.
162 It is important that the box sizes at the bottom of your input file
163 are correct when the periodicity is to be removed.
167 When writing 
168 .B .pdb
169 files, B-factors can be
170 added with the 
171 .B -bf
172 option. B-factors are read
173 from a file with with following format: first line states number of
174 entries in the file, next lines state an index
175 followed by a B-factor. The B-factors will be attached per residue
176 unless an index is larger than the number of residues or unless the
178 .B -atom
179 option is set. Obviously, any type of numeric data can
180 be added instead of B-factors. 
181 .B -legend
182 will produce
183 a row of CA atoms with B-factors ranging from the minimum to the
184 maximum value found, effectively making a legend for viewing.
188 With the option -mead a special pdb (pqr) file for the MEAD electrostatics
189 program (Poisson-Boltzmann solver) can be made. A further prerequisite
190 is that the input file is a run input file.
191 The B-factor field is then filled with the Van der Waals radius
192 of the atoms while the occupancy field will hold the charge.
196 The option -grasp is similar, but it puts the charges in the B-factor
197 and the radius in the occupancy.
201 Finally with option 
202 .B -label
203 editconf can add a chain identifier
204 to a pdb file, which can be useful for analysis with e.g. rasmol.
207 To convert a truncated octrahedron file produced by a package which uses
208 a cubic box with the corners cut off (such as Gromos) use:
211 .B editconf -f in -rotate 0 45 35.264 -bt o -box veclen -o out
214 where 
215 .B veclen
216 is the size of the cubic box times sqrt(3)/2.
217 .SH FILES
218 .BI "-f" " conf.gro" 
219 .B Input
220  Structure file: gro g96 pdb tpr tpb tpa 
222 .BI "-n" " index.ndx" 
223 .B Input, Opt.
224  Index file 
226 .BI "-o" " out.gro" 
227 .B Output, Opt.
228  Structure file: gro g96 pdb 
230 .BI "-mead" " mead.pqr" 
231 .B Output, Opt.
232  Coordinate file for MEAD 
234 .BI "-bf" " bfact.dat" 
235 .B Input, Opt.
236  Generic data file 
238 .SH OTHER OPTIONS
239 .BI "-[no]h"  "no    "
240  Print help info and quit
242 .BI "-nice"  " int" " 0" 
243  Set the nicelevel
245 .BI "-[no]w"  "no    "
246  View output xvg, xpm, eps and pdb files
248 .BI "-[no]ndef"  "no    "
249  Choose output from default index groups
251 .BI "-bt"  " enum" " triclinic" 
252  Box type for -box and -d: 
253 .B triclinic
255 .B cubic
257 .B dodecahedron
258 or 
259 .B octahedron
262 .BI "-box"  " vector" " 0 0 0" 
263  Box vector lengths (a,b,c)
265 .BI "-angles"  " vector" " 90 90 90" 
266  Angles between the box vectors (bc,ac,ab)
268 .BI "-d"  " real" " 0     " 
269  Distance between the solute and the box
271 .BI "-[no]c"  "no    "
272  Center molecule in box (implied by -box and -d)
274 .BI "-center"  " vector" " 0 0 0" 
275  Coordinates of geometrical center
277 .BI "-translate"  " vector" " 0 0 0" 
278  Translation
280 .BI "-rotate"  " vector" " 0 0 0" 
281  Rotation around the X, Y and Z axes in degrees
283 .BI "-[no]princ"  "no    "
284  Orient molecule(s) along their principal axes
286 .BI "-scale"  " vector" " 1 1 1" 
287  Scaling factor
289 .BI "-density"  " real" " 1000  " 
290  Density (g/l) of the output box achieved by scaling
292 .BI "-[no]pbc"  "no    "
293  Remove the periodicity (make molecule whole again)
295 .BI "-[no]grasp"  "no    "
296  Store the charge of the atom in the B-factor field and the radius of the atom in the occupancy field
298 .BI "-rvdw"  " real" " 0.12  " 
299  Default Van der Waals radius (in nm) if one can not be found in the database or if no parameters are present in the topology file
301 .BI "-sig56"  " real" " 0     " 
302  Use rmin/2 (minimum in the Van der Waals potential) rather than sigma/2 
304 .BI "-[no]vdwread"  "no    "
305  Read the Van der Waals radii from the file vdwradii.dat rather than computing the radii based on the force field
307 .BI "-[no]atom"  "no    "
308  Force B-factor attachment per atom
310 .BI "-[no]legend"  "no    "
311  Make B-factor legend
313 .BI "-label"  " string" " A" 
314  Add chain label for all residues
316 .SH KNOWN PROBLEMS
317 \- For complex molecules, the periodicity removal routine may break down, in that case you can use trjconv