Release 4.5.6
[alexxy/gromacs.git] / man / man1 / editconf.1
1 .TH editconf 1 "Fri 18 Jan 2013" "" "GROMACS suite, VERSION 4.5.6"
2 .SH NAME
3 editconf - edits the box and writes subgroups 
4
5 .B VERSION 4.5.6
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 "\-resnr" " int "
33 .BI "\-[no]grasp" ""
34 .BI "\-rvdw" " real "
35 .BI "\-[no]sig56" ""
36 .BI "\-[no]vdwread" ""
37 .BI "\-[no]atom" ""
38 .BI "\-[no]legend" ""
39 .BI "\-label" " string "
40 .BI "\-[no]conect" ""
41 .SH DESCRIPTION
42 \&\fB editconf\fR converts generic structure format to \fB .gro\fR, \fB .g96\fR
43 \&or \fB .pdb\fR.
44 \&
45
46
47 \&The box can be modified with options \fB \-box\fR, \fB \-d\fR and
48 \&\fB \-angles\fR. Both \fB \-box\fR and \fB \-d\fR
49 \&will center the system in the box, unless \fB \-noc\fR is used.
50 \&
51
52
53 \&Option \fB \-bt\fR determines the box type: \fB triclinic\fR is a
54 \&triclinic box, \fB cubic\fR is a rectangular box with all sides equal
55 \&\fB dodecahedron\fR represents a rhombic dodecahedron and
56 \&\fB octahedron\fR is a truncated octahedron.
57 \&The last two are special cases of a triclinic box.
58 \&The length of the three box vectors of the truncated octahedron is the
59 \&shortest distance between two opposite hexagons.
60 \&Relative to a cubic box with some periodic image distance, the volume of a 
61 \&dodecahedron with this same periodic distance is 0.71 times that of the cube, 
62 \&and that of a truncated octahedron is 0.77 times.
63 \&
64
65
66 \&Option \fB \-box\fR requires only
67 \&one value for a cubic, rhombic dodecahedral, or truncated octahedral box.
68 \&
69
70
71 \&With \fB \-d\fR and a \fB triclinic\fR box the size of the system in the \fI x\fR\-, \fI y\fR\-,
72 \&and \fI z\fR\-directions is used. With \fB \-d\fR and \fB cubic\fR,
73 \&\fB dodecahedron\fR or \fB octahedron\fR boxes, the dimensions are set
74 \&to the diameter of the system (largest distance between atoms) plus twice
75 \&the specified distance.
76 \&
77
78
79 \&Option \fB \-angles\fR is only meaningful with option \fB \-box\fR and
80 \&a triclinic box and cannot be used with option \fB \-d\fR.
81 \&
82
83
84 \&When \fB \-n\fR or \fB \-ndef\fR is set, a group
85 \&can be selected for calculating the size and the geometric center,
86 \&otherwise the whole system is used.
87 \&
88
89
90 \&\fB \-rotate\fR rotates the coordinates and velocities.
91 \&
92
93
94 \&\fB \-princ\fR aligns the principal axes of the system along the
95 \&coordinate axes, with the longest axis aligned with the \fI x\fR\-axis. 
96 \&This may allow you to decrease the box volume,
97 \&but beware that molecules can rotate significantly in a nanosecond.
98 \&
99
100
101 \&Scaling is applied before any of the other operations are
102 \&performed. Boxes and coordinates can be scaled to give a certain density (option
103 \&\fB \-density\fR). Note that this may be inaccurate in case a \fB .gro\fR
104 \&file is given as input. A special feature of the scaling option is that when the
105 \&factor \-1 is given in one dimension, one obtains a mirror image,
106 \&mirrored in one of the planes. When one uses \-1 in three dimensions, 
107 \&a point\-mirror image is obtained.
108
109
110 \&Groups are selected after all operations have been applied.
111
112
113 \&Periodicity can be removed in a crude manner.
114 \&It is important that the box vectors at the bottom of your input file
115 \&are correct when the periodicity is to be removed.
116 \&
117
118
119 \&When writing \fB .pdb\fR files, B\-factors can be
120 \&added with the \fB \-bf\fR option. B\-factors are read
121 \&from a file with with following format: first line states number of
122 \&entries in the file, next lines state an index
123 \&followed by a B\-factor. The B\-factors will be attached per residue
124 \&unless an index is larger than the number of residues or unless the
125 \&\fB \-atom\fR option is set. Obviously, any type of numeric data can
126 \&be added instead of B\-factors. \fB \-legend\fR will produce
127 \&a row of CA atoms with B\-factors ranging from the minimum to the
128 \&maximum value found, effectively making a legend for viewing.
129 \&
130
131
132 \&With the option \fB \-mead\fR a special \fB .pdb\fR (\fB .pqr\fR)
133 \&file for the MEAD electrostatics
134 \&program (Poisson\-Boltzmann solver) can be made. A further prerequisite
135 \&is that the input file is a run input file.
136 \&The B\-factor field is then filled with the Van der Waals radius
137 \&of the atoms while the occupancy field will hold the charge.
138 \&
139
140
141 \&The option \fB \-grasp\fR is similar, but it puts the charges in the B\-factor
142 \&and the radius in the occupancy.
143 \&
144
145
146 \&Option \fB \-align\fR allows alignment
147 \&of the principal axis of a specified group against the given vector, 
148 \&with an optional center of rotation specified by \fB \-aligncenter\fR.
149 \&
150
151
152 \&Finally, with option \fB \-label\fR, \fB editconf\fR can add a chain identifier
153 \&to a \fB .pdb\fR file, which can be useful for analysis with e.g. Rasmol.
154 \&
155
156
157 \&To convert a truncated octrahedron file produced by a package which uses
158 \&a cubic box with the corners cut off (such as GROMOS), use:
159
160 \&\fB editconf \-f in \-rotate 0 45 35.264 \-bt o \-box veclen \-o out\fR
161
162 \&where \fB veclen\fR is the size of the cubic box times sqrt(3)/2.
163 .SH FILES
164 .BI "\-f" " conf.gro" 
165 .B Input
166  Structure file: gro g96 pdb tpr etc. 
167
168 .BI "\-n" " index.ndx" 
169 .B Input, Opt.
170  Index file 
171
172 .BI "\-o" " out.gro" 
173 .B Output, Opt.
174  Structure file: gro g96 pdb etc. 
175
176 .BI "\-mead" " mead.pqr" 
177 .B Output, Opt.
178  Coordinate file for MEAD 
179
180 .BI "\-bf" " bfact.dat" 
181 .B Input, Opt.
182  Generic data file 
183
184 .SH OTHER OPTIONS
185 .BI "\-[no]h"  "no    "
186  Print help info and quit
187
188 .BI "\-[no]version"  "no    "
189  Print version info and quit
190
191 .BI "\-nice"  " int" " 0" 
192  Set the nicelevel
193
194 .BI "\-[no]w"  "no    "
195  View output \fB .xvg\fR, \fB .xpm\fR, \fB .eps\fR and \fB .pdb\fR files
196
197 .BI "\-[no]ndef"  "no    "
198  Choose output from default index groups
199
200 .BI "\-bt"  " enum" " triclinic" 
201  Box type for \fB \-box\fR and \fB \-d\fR: \fB triclinic\fR, \fB cubic\fR, \fB dodecahedron\fR or \fB octahedron\fR
202
203 .BI "\-box"  " vector" " 0 0 0" 
204  Box vector lengths (a,b,c)
205
206 .BI "\-angles"  " vector" " 90 90 90" 
207  Angles between the box vectors (bc,ac,ab)
208
209 .BI "\-d"  " real" " 0     " 
210  Distance between the solute and the box
211
212 .BI "\-[no]c"  "no    "
213  Center molecule in box (implied by \fB \-box\fR and \fB \-d\fR)
214
215 .BI "\-center"  " vector" " 0 0 0" 
216  Coordinates of geometrical center
217
218 .BI "\-aligncenter"  " vector" " 0 0 0" 
219  Center of rotation for alignment
220
221 .BI "\-align"  " vector" " 0 0 0" 
222  Align to target vector
223
224 .BI "\-translate"  " vector" " 0 0 0" 
225  Translation
226
227 .BI "\-rotate"  " vector" " 0 0 0" 
228  Rotation around the X, Y and Z axes in degrees
229
230 .BI "\-[no]princ"  "no    "
231  Orient molecule(s) along their principal axes
232
233 .BI "\-scale"  " vector" " 1 1 1" 
234  Scaling factor
235
236 .BI "\-density"  " real" " 1000  " 
237  Density (g/L) of the output box achieved by scaling
238
239 .BI "\-[no]pbc"  "no    "
240  Remove the periodicity (make molecule whole again)
241
242 .BI "\-resnr"  " int" " \-1" 
243   Renumber residues starting from resnr
244
245 .BI "\-[no]grasp"  "no    "
246  Store the charge of the atom in the B\-factor field and the radius of the atom in the occupancy field
247
248 .BI "\-rvdw"  " real" " 0.12  " 
249  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
250
251 .BI "\-[no]sig56"  "no    "
252  Use rmin/2 (minimum in the Van der Waals potential) rather than sigma/2 
253
254 .BI "\-[no]vdwread"  "no    "
255  Read the Van der Waals radii from the file \fB vdwradii.dat\fR rather than computing the radii based on the force field
256
257 .BI "\-[no]atom"  "no    "
258  Force B\-factor attachment per atom
259
260 .BI "\-[no]legend"  "no    "
261  Make B\-factor legend
262
263 .BI "\-label"  " string" " A" 
264  Add chain label for all residues
265
266 .BI "\-[no]conect"  "no    "
267  Add CONECT records to a \fB .pdb\fR file when written. Can only be done when a topology is present
268
269 .SH KNOWN PROBLEMS
270 \- For complex molecules, the periodicity removal routine may break down, in that case you can use \fB trjconv\fR.
271
272 .SH SEE ALSO
273 .BR gromacs(7)
274
275 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.