Merge branch 'release-4-5-patches' of git@git.gromacs.org:gromacs into release-4...
[gromacs/rigid-bodies.git] / man / man1 / editconf.1
blob402147ad7be43630ebdc49c8fc2258b0c3f379e3
1 .TH editconf 1 "Thu 26 Aug 2010" "" "GROMACS suite, VERSION 4.5"
2 .SH NAME
3 editconf - edits the box and writes subgroups 
5 .B VERSION 4.5
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 "\-[no]version" ""
15 .BI "\-nice" " int "
16 .BI "\-[no]w" ""
17 .BI "\-[no]ndef" ""
18 .BI "\-bt" " enum "
19 .BI "\-box" " vector "
20 .BI "\-angles" " vector "
21 .BI "\-d" " real "
22 .BI "\-[no]c" ""
23 .BI "\-center" " vector "
24 .BI "\-aligncenter" " vector "
25 .BI "\-align" " vector "
26 .BI "\-translate" " vector "
27 .BI "\-rotate" " vector "
28 .BI "\-[no]princ" ""
29 .BI "\-scale" " vector "
30 .BI "\-density" " real "
31 .BI "\-[no]pbc" ""
32 .BI "\-[no]grasp" ""
33 .BI "\-rvdw" " real "
34 .BI "\-sig56" " real "
35 .BI "\-[no]vdwread" ""
36 .BI "\-[no]atom" ""
37 .BI "\-[no]legend" ""
38 .BI "\-label" " string "
39 .BI "\-[no]conect" ""
40 .SH DESCRIPTION
41 \&editconf converts generic structure format to \fB .gro\fR, \fB .g96\fR
42 \&or \fB .pdb\fR.
46 \&The box can be modified with options \fB \-box\fR, \fB \-d\fR and
47 \&\fB \-angles\fR. Both \fB \-box\fR and \fB \-d\fR
48 \&will center the system in the box, unless \fB \-noc\fR is used.
52 \&Option \fB \-bt\fR determines the box type: \fB triclinic\fR is a
53 \&triclinic box, \fB cubic\fR is a rectangular box with all sides equal
54 \&\fB dodecahedron\fR represents a rhombic dodecahedron and
55 \&\fB octahedron\fR is a truncated octahedron.
56 \&The last two are special cases of a triclinic box.
57 \&The length of the three box vectors of the truncated octahedron is the
58 \&shortest distance between two opposite hexagons.
59 \&The volume of a dodecahedron is 0.71 and that of a truncated octahedron
60 \&is 0.77 of that of a cubic box with the same periodic image distance.
64 \&Option \fB \-box\fR requires only
65 \&one value for a cubic box, dodecahedron and a truncated octahedron.
69 \&With \fB \-d\fR and a \fB triclinic\fR box the size of the system in the x, y
70 \&and z directions is used. With \fB \-d\fR and \fB cubic\fR,
71 \&\fB dodecahedron\fR or \fB octahedron\fR boxes, the dimensions are set
72 \&to the diameter of the system (largest distance between atoms) plus twice
73 \&the specified distance.
77 \&Option \fB \-angles\fR is only meaningful with option \fB \-box\fR and
78 \&a triclinic box and can not be used with option \fB \-d\fR.
82 \&When \fB \-n\fR or \fB \-ndef\fR is set, a group
83 \&can be selected for calculating the size and the geometric center,
84 \&otherwise the whole system is used.
88 \&\fB \-rotate\fR rotates the coordinates and velocities.
92 \&\fB \-princ\fR aligns the principal axes of the system along the
93 \&coordinate axes, this may allow you to decrease the box volume,
94 \&but beware that molecules can rotate significantly in a nanosecond.
98 \&Scaling is applied before any of the other operations are
99 \&performed. Boxes and coordinates can be scaled to give a certain density (option
100 \&\fB \-density\fR). Note that this may be inaccurate in case a gro
101 \&file is given as input. A special feature of the scaling option, when the
102 \&factor \-1 is given in one dimension, one obtains a mirror image,
103 \&mirrored in one of the plains, when one uses \-1 in three dimensions
104 \&a point\-mirror image is obtained.
107 \&Groups are selected after all operations have been applied.
110 \&Periodicity can be removed in a crude manner.
111 \&It is important that the box sizes at the bottom of your input file
112 \&are correct when the periodicity is to be removed.
116 \&When writing \fB .pdb\fR files, B\-factors can be
117 \&added with the \fB \-bf\fR option. B\-factors are read
118 \&from a file with with following format: first line states number of
119 \&entries in the file, next lines state an index
120 \&followed by a B\-factor. The B\-factors will be attached per residue
121 \&unless an index is larger than the number of residues or unless the
122 \&\fB \-atom\fR option is set. Obviously, any type of numeric data can
123 \&be added instead of B\-factors. \fB \-legend\fR will produce
124 \&a row of CA atoms with B\-factors ranging from the minimum to the
125 \&maximum value found, effectively making a legend for viewing.
129 \&With the option \-mead a special pdb (pqr) file for the MEAD electrostatics
130 \&program (Poisson\-Boltzmann solver) can be made. A further prerequisite
131 \&is that the input file is a run input file.
132 \&The B\-factor field is then filled with the Van der Waals radius
133 \&of the atoms while the occupancy field will hold the charge.
137 \&The option \-grasp is similar, but it puts the charges in the B\-factor
138 \&and the radius in the occupancy.
142 \&Option \fB \-align\fR allows alignment
143 \&of the principal axis of a specified group against the given vector, 
144 \&with an optional center of rotation specified by \fB \-aligncenter\fR.
148 \&Finally with option \fB \-label\fR editconf can add a chain identifier
149 \&to a pdb file, which can be useful for analysis with e.g. rasmol.
153 \&To convert a truncated octrahedron file produced by a package which uses
154 \&a cubic box with the corners cut off (such as Gromos) use:
156 \&\fB editconf \-f in \-rotate 0 45 35.264 \-bt o \-box veclen \-o out\fR
158 \&where \fB veclen\fR is the size of the cubic box times sqrt(3)/2.
159 .SH FILES
160 .BI "\-f" " conf.gro" 
161 .B Input
162  Structure file: gro g96 pdb tpr etc. 
164 .BI "\-n" " index.ndx" 
165 .B Input, Opt.
166  Index file 
168 .BI "\-o" " out.gro" 
169 .B Output, Opt.
170  Structure file: gro g96 pdb etc. 
172 .BI "\-mead" " mead.pqr" 
173 .B Output, Opt.
174  Coordinate file for MEAD 
176 .BI "\-bf" " bfact.dat" 
177 .B Input, Opt.
178  Generic data file 
180 .SH OTHER OPTIONS
181 .BI "\-[no]h"  "no    "
182  Print help info and quit
184 .BI "\-[no]version"  "no    "
185  Print version info and quit
187 .BI "\-nice"  " int" " 0" 
188  Set the nicelevel
190 .BI "\-[no]w"  "no    "
191  View output xvg, xpm, eps and pdb files
193 .BI "\-[no]ndef"  "no    "
194  Choose output from default index groups
196 .BI "\-bt"  " enum" " triclinic" 
197  Box type for \-box and \-d: \fB triclinic\fR, \fB cubic\fR, \fB dodecahedron\fR or \fB octahedron\fR
199 .BI "\-box"  " vector" " 0 0 0" 
200  Box vector lengths (a,b,c)
202 .BI "\-angles"  " vector" " 90 90 90" 
203  Angles between the box vectors (bc,ac,ab)
205 .BI "\-d"  " real" " 0     " 
206  Distance between the solute and the box
208 .BI "\-[no]c"  "no    "
209  Center molecule in box (implied by \-box and \-d)
211 .BI "\-center"  " vector" " 0 0 0" 
212  Coordinates of geometrical center
214 .BI "\-aligncenter"  " vector" " 0 0 0" 
215  Center of rotation for alignment
217 .BI "\-align"  " vector" " 0 0 0" 
218  Align to target vector
220 .BI "\-translate"  " vector" " 0 0 0" 
221  Translation
223 .BI "\-rotate"  " vector" " 0 0 0" 
224  Rotation around the X, Y and Z axes in degrees
226 .BI "\-[no]princ"  "no    "
227  Orient molecule(s) along their principal axes
229 .BI "\-scale"  " vector" " 1 1 1" 
230  Scaling factor
232 .BI "\-density"  " real" " 1000  " 
233  Density (g/l) of the output box achieved by scaling
235 .BI "\-[no]pbc"  "no    "
236  Remove the periodicity (make molecule whole again)
238 .BI "\-[no]grasp"  "no    "
239  Store the charge of the atom in the B\-factor field and the radius of the atom in the occupancy field
241 .BI "\-rvdw"  " real" " 0.12  " 
242  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
244 .BI "\-sig56"  " real" " 0     " 
245  Use rmin/2 (minimum in the Van der Waals potential) rather than sigma/2 
247 .BI "\-[no]vdwread"  "no    "
248  Read the Van der Waals radii from the file vdwradii.dat rather than computing the radii based on the force field
250 .BI "\-[no]atom"  "no    "
251  Force B\-factor attachment per atom
253 .BI "\-[no]legend"  "no    "
254  Make B\-factor legend
256 .BI "\-label"  " string" " A" 
257  Add chain label for all residues
259 .BI "\-[no]conect"  "no    "
260  Add CONECT records to a pdb file when written. Can only be done when a topology is present
262 .SH KNOWN PROBLEMS
263 \- For complex molecules, the periodicity removal routine may break down, 
265 \- in that case you can use trjconv.
267 .SH SEE ALSO
268 .BR gromacs(7)
270 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.