Merge branch 'master' of git://git.gromacs.org/gromacs
[gromacs/adressmacs.git] / share / html / online / editconf.html
blobcebf81c79d1af026b2152b797fde03183be3617e
1 <HTML>
2 <HEAD>
3 <TITLE>editconf</TITLE>
4 <LINK rel=stylesheet href="style.css" type="text/css">
5 <BODY text="#000000" bgcolor="#FFFFFF" link="#0000FF" vlink="#990000" alink="#FF0000">
6 <TABLE WIDTH="98%" NOBORDER >
7 <TR><TD WIDTH=400>
8 <TABLE WIDTH=400 NOBORDER>
9 <TD WIDTH=116>
10 <a href="http://www.gromacs.org/"><img SRC="../images/gmxlogo_small.png"BORDER=0 </a></td>
11 <td ALIGN=LEFT VALIGN=TOP WIDTH=280><br><h2>editconf</h2><font size=-1><A HREF="../online.html">Main Table of Contents</A></font><br><br></td>
12 </TABLE></TD><TD WIDTH="*" ALIGN=RIGHT VALIGN=BOTTOM><p><B>VERSION 4.5<br>
13 Thu 26 Aug 2010</B></td></tr></TABLE>
14 <HR>
15 <H3>Description</H3>
16 <p>
17 editconf converts generic structure format to <tt>.<a href="gro.html">gro</a></tt>, <tt>.<a href="g96.html">g96</a></tt>
18 or <tt>.<a href="pdb.html">pdb</a></tt>.
19 <p>
20 The box can be modified with options <tt>-box</tt>, <tt>-d</tt> and
21 <tt>-angles</tt>. Both <tt>-box</tt> and <tt>-d</tt>
22 will center the system in the box, unless <tt>-noc</tt> is used.
23 <p>
24 Option <tt>-bt</tt> determines the box type: <tt>triclinic</tt> is a
25 triclinic box, <tt>cubic</tt> is a rectangular box with all sides equal
26 <tt>dodecahedron</tt> represents a rhombic dodecahedron and
27 <tt>octahedron</tt> is a truncated octahedron.
28 The last two are special cases of a triclinic box.
29 The length of the three box vectors of the truncated octahedron is the
30 shortest distance between two opposite hexagons.
31 The volume of a dodecahedron is 0.71 and that of a truncated octahedron
32 is 0.77 of that of a cubic box with the same periodic image distance.
33 <p>
34 Option <tt>-box</tt> requires only
35 one value for a cubic box, dodecahedron and a truncated octahedron.
36 <p>
37 With <tt>-d</tt> and a <tt>triclinic</tt> box the size of the system in the x, y
38 and z directions is used. With <tt>-d</tt> and <tt>cubic</tt>,
39 <tt>dodecahedron</tt> or <tt>octahedron</tt> boxes, the dimensions are set
40 to the diameter of the system (largest distance between atoms) plus twice
41 the specified distance.
42 <p>
43 Option <tt>-angles</tt> is only meaningful with option <tt>-box</tt> and
44 a triclinic box and can not be used with option <tt>-d</tt>.
45 <p>
46 When <tt>-n</tt> or <tt>-ndef</tt> is set, a group
47 can be selected for calculating the size and the geometric center,
48 otherwise the whole system is used.
49 <p>
50 <tt>-rotate</tt> rotates the coordinates and velocities.
51 <p>
52 <tt>-princ</tt> aligns the principal axes of the system along the
53 coordinate axes, this may allow you to decrease the box volume,
54 but beware that molecules can rotate significantly in a nanosecond.
55 <p>
56 Scaling is applied before any of the other operations are
57 performed. Boxes and coordinates can be scaled to give a certain density (option
58 <tt>-density</tt>). Note that this may be inaccurate in case a <a href="gro.html">gro</a>
59 file is given as input. A special feature of the scaling option, when the
60 factor -1 is given in one dimension, one obtains a mirror image,
61 mirrored in one of the plains, when one uses -1 in three dimensions
62 a point-mirror image is obtained.<p>
63 Groups are selected after all operations have been applied.<p>
64 Periodicity can be removed in a crude manner.
65 It is important that the box sizes at the bottom of your input file
66 are correct when the periodicity is to be removed.
67 <p>
68 When writing <tt>.<a href="pdb.html">pdb</a></tt> files, B-factors can be
69 added with the <tt>-bf</tt> option. B-factors are read
70 from a file with with following format: first line states number of
71 entries in the file, next lines state an index
72 followed by a B-factor. The B-factors will be attached per residue
73 unless an index is larger than the number of residues or unless the
74 <tt>-atom</tt> option is set. Obviously, any type of numeric data can
75 be added instead of B-factors. <tt>-legend</tt> will produce
76 a row of CA atoms with B-factors ranging from the minimum to the
77 maximum value found, effectively making a legend for viewing.
78 <p>
79 With the option -mead a special <a href="pdb.html">pdb</a> (pqr) file for the MEAD electrostatics
80 program (Poisson-Boltzmann solver) can be made. A further prerequisite
81 is that the input file is a run input file.
82 The B-factor field is then filled with the Van der Waals radius
83 of the atoms while the occupancy field will hold the charge.
84 <p>
85 The option -grasp is similar, but it puts the charges in the B-factor
86 and the radius in the occupancy.
87 <p>
88 Option <tt>-align</tt> allows alignment
89 of the principal axis of a specified group against the given vector,
90 with an optional center of rotation specified by <tt>-aligncenter</tt>.
91 <p>
92 Finally with option <tt>-label</tt> editconf can add a chain identifier
93 to a <a href="pdb.html">pdb</a> file, which can be useful for analysis with e.g. rasmol.
94 <p>
95 To convert a truncated octrahedron file produced by a package which uses
96 a cubic box with the corners cut off (such as Gromos) use:<br>
97 <tt>editconf -f &lt;in&gt; -rotate 0 45 35.264 -bt o -box &lt;veclen&gt; -o &lt;out&gt;</tt><br>
98 where <tt>veclen</tt> is the size of the cubic box times sqrt(3)/2.
99 <P>
100 <H3>Files</H3>
101 <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=2>
102 <TR><TH>option</TH><TH>filename</TH><TH>type</TH><TH>description</TH></TR>
103 <TR><TD ALIGN=RIGHT> <b><tt>-f</tt></b> </TD><TD ALIGN=RIGHT> <tt><a href="files.html"> conf.gro</a></tt> </TD><TD> Input </TD><TD> Structure file: <a href="gro.html">gro</a> <a href="g96.html">g96</a> <a href="pdb.html">pdb</a> <a href="tpr.html">tpr</a> etc. </TD></TR>
104 <TR><TD ALIGN=RIGHT> <b><tt>-n</tt></b> </TD><TD ALIGN=RIGHT> <tt><a href="ndx.html"> index.ndx</a></tt> </TD><TD> Input, Opt. </TD><TD> Index file </TD></TR>
105 <TR><TD ALIGN=RIGHT> <b><tt>-o</tt></b> </TD><TD ALIGN=RIGHT> <tt><a href="files.html"> out.gro</a></tt> </TD><TD> Output, Opt. </TD><TD> Structure file: <a href="gro.html">gro</a> <a href="g96.html">g96</a> <a href="pdb.html">pdb</a> etc. </TD></TR>
106 <TR><TD ALIGN=RIGHT> <b><tt>-mead</tt></b> </TD><TD ALIGN=RIGHT> <tt><a href="pqr.html"> mead.pqr</a></tt> </TD><TD> Output, Opt. </TD><TD> Coordinate file for MEAD </TD></TR>
107 <TR><TD ALIGN=RIGHT> <b><tt>-bf</tt></b> </TD><TD ALIGN=RIGHT> <tt><a href="dat.html"> bfact.dat</a></tt> </TD><TD> Input, Opt. </TD><TD> Generic data file </TD></TR>
108 </TABLE>
110 <H3>Other options</H3>
111 <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=2>
112 <TR><TH>option</TH><TH>type</TH><TH>default</TH><TH>description</TH></TR>
113 <TR><TD ALIGN=RIGHT> <b><tt>-[no]h</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Print help info and quit </TD></TD>
114 <TR><TD ALIGN=RIGHT> <b><tt>-[no]version</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Print version info and quit </TD></TD>
115 <TR><TD ALIGN=RIGHT> <b><tt>-nice</tt></b> </TD><TD ALIGN=RIGHT> int </TD><TD ALIGN=RIGHT> <tt>0</tt> </TD><TD> Set the nicelevel </TD></TD>
116 <TR><TD ALIGN=RIGHT> <b><tt>-[no]w</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> View output <a href="xvg.html">xvg</a>, <a href="xpm.html">xpm</a>, <a href="eps.html">eps</a> and <a href="pdb.html">pdb</a> files </TD></TD>
117 <TR><TD ALIGN=RIGHT> <b><tt>-[no]ndef</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Choose output from default index groups </TD></TD>
118 <TR><TD ALIGN=RIGHT> <b><tt>-bt</tt></b> </TD><TD ALIGN=RIGHT> enum </TD><TD ALIGN=RIGHT> <tt>triclinic</tt> </TD><TD> Box type for -box and -d: <tt>triclinic</tt>, <tt>cubic</tt>, <tt>dodecahedron</tt> or <tt>octahedron</tt> </TD></TD>
119 <TR><TD ALIGN=RIGHT> <b><tt>-box</tt></b> </TD><TD ALIGN=RIGHT> vector </TD><TD ALIGN=RIGHT> <tt>0 0 0</tt> </TD><TD> Box vector lengths (a,b,c) </TD></TD>
120 <TR><TD ALIGN=RIGHT> <b><tt>-angles</tt></b> </TD><TD ALIGN=RIGHT> vector </TD><TD ALIGN=RIGHT> <tt>90 90 90</tt> </TD><TD> Angles between the box vectors (bc,ac,ab) </TD></TD>
121 <TR><TD ALIGN=RIGHT> <b><tt>-d</tt></b> </TD><TD ALIGN=RIGHT> real </TD><TD ALIGN=RIGHT> <tt>0 </tt> </TD><TD> Distance between the solute and the box </TD></TD>
122 <TR><TD ALIGN=RIGHT> <b><tt>-[no]c</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Center molecule in box (implied by -box and -d) </TD></TD>
123 <TR><TD ALIGN=RIGHT> <b><tt>-center</tt></b> </TD><TD ALIGN=RIGHT> vector </TD><TD ALIGN=RIGHT> <tt>0 0 0</tt> </TD><TD> Coordinates of geometrical center </TD></TD>
124 <TR><TD ALIGN=RIGHT> <b><tt>-aligncenter</tt></b> </TD><TD ALIGN=RIGHT> vector </TD><TD ALIGN=RIGHT> <tt>0 0 0</tt> </TD><TD> Center of rotation for alignment </TD></TD>
125 <TR><TD ALIGN=RIGHT> <b><tt>-align</tt></b> </TD><TD ALIGN=RIGHT> vector </TD><TD ALIGN=RIGHT> <tt>0 0 0</tt> </TD><TD> Align to target vector </TD></TD>
126 <TR><TD ALIGN=RIGHT> <b><tt>-translate</tt></b> </TD><TD ALIGN=RIGHT> vector </TD><TD ALIGN=RIGHT> <tt>0 0 0</tt> </TD><TD> Translation </TD></TD>
127 <TR><TD ALIGN=RIGHT> <b><tt>-rotate</tt></b> </TD><TD ALIGN=RIGHT> vector </TD><TD ALIGN=RIGHT> <tt>0 0 0</tt> </TD><TD> Rotation around the X, Y and Z axes in degrees </TD></TD>
128 <TR><TD ALIGN=RIGHT> <b><tt>-[no]princ</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Orient molecule(s) along their principal axes </TD></TD>
129 <TR><TD ALIGN=RIGHT> <b><tt>-scale</tt></b> </TD><TD ALIGN=RIGHT> vector </TD><TD ALIGN=RIGHT> <tt>1 1 1</tt> </TD><TD> Scaling factor </TD></TD>
130 <TR><TD ALIGN=RIGHT> <b><tt>-density</tt></b> </TD><TD ALIGN=RIGHT> real </TD><TD ALIGN=RIGHT> <tt>1000 </tt> </TD><TD> Density (g/l) of the output box achieved by scaling </TD></TD>
131 <TR><TD ALIGN=RIGHT> <b><tt>-[no]pbc</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Remove the periodicity (make molecule whole again) </TD></TD>
132 <TR><TD ALIGN=RIGHT> <b><tt>-[no]grasp</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Store the charge of the atom in the B-factor field and the radius of the atom in the occupancy field </TD></TD>
133 <TR><TD ALIGN=RIGHT> <b><tt>-rvdw</tt></b> </TD><TD ALIGN=RIGHT> real </TD><TD ALIGN=RIGHT> <tt>0.12 </tt> </TD><TD> 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 </TD></TD>
134 <TR><TD ALIGN=RIGHT> <b><tt>-sig56</tt></b> </TD><TD ALIGN=RIGHT> real </TD><TD ALIGN=RIGHT> <tt>0 </tt> </TD><TD> Use rmin/2 (minimum in the Van der Waals potential) rather than sigma/2 </TD></TD>
135 <TR><TD ALIGN=RIGHT> <b><tt>-[no]vdwread</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Read the Van der Waals radii from the file vdwradii.<a href="dat.html">dat</a> rather than computing the radii based on the force field </TD></TD>
136 <TR><TD ALIGN=RIGHT> <b><tt>-[no]atom</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Force B-factor attachment per atom </TD></TD>
137 <TR><TD ALIGN=RIGHT> <b><tt>-[no]legend</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Make B-factor legend </TD></TD>
138 <TR><TD ALIGN=RIGHT> <b><tt>-label</tt></b> </TD><TD ALIGN=RIGHT> string </TD><TD ALIGN=RIGHT> <tt>A</tt> </TD><TD> Add chain label for all residues </TD></TD>
139 <TR><TD ALIGN=RIGHT> <b><tt>-[no]conect</tt></b> </TD><TD ALIGN=RIGHT> gmx_bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Add CONECT records to a <a href="pdb.html">pdb</a> file when written. Can only be done when a topology is present </TD></TD>
140 </TABLE>
142 <H3>Known problems</H3>
143 <UL>
144 <LI>For complex molecules, the periodicity removal routine may break down,
145 <LI>in that case you can use <a href="trjconv.html">trjconv</a>.
146 </UL>
148 <hr>
149 <div ALIGN=RIGHT>
150 <font size="-1"><a href="http://www.gromacs.org">http://www.gromacs.org</a></font><br>
151 <font size="-1"><a href="mailto:gromacs@gromacs.org">gromacs@gromacs.org</a></font><br>
152 </div>
153 </BODY>