Merge branch 'release-4-5-patches' of git@git.gromacs.org:gromacs into release-4...
[gromacs/rigid-bodies.git] / man / man1 / g_membed.1
blob659033e215377802285d4d4519bbb5108cdd840d
1 .TH g_membed 1 "Thu 26 Aug 2010" "" "GROMACS suite, VERSION 4.5"
2 .SH NAME
3 g_membed - embeds a protein into a lipid bilayer
5 .B VERSION 4.5
6 .SH SYNOPSIS
7 \f3g_membed\fP
8 .BI "\-f" " into_mem.tpr "
9 .BI "\-n" " index.ndx "
10 .BI "\-p" " topol.top "
11 .BI "\-o" " traj.trr "
12 .BI "\-x" " traj.xtc "
13 .BI "\-cpi" " state.cpt "
14 .BI "\-cpo" " state.cpt "
15 .BI "\-c" " membedded.gro "
16 .BI "\-e" " ener.edr "
17 .BI "\-g" " md.log "
18 .BI "\-ei" " sam.edi "
19 .BI "\-rerun" " rerun.xtc "
20 .BI "\-table" " table.xvg "
21 .BI "\-tablep" " tablep.xvg "
22 .BI "\-tableb" " table.xvg "
23 .BI "\-dhdl" " dhdl.xvg "
24 .BI "\-field" " field.xvg "
25 .BI "\-table" " table.xvg "
26 .BI "\-tablep" " tablep.xvg "
27 .BI "\-tableb" " table.xvg "
28 .BI "\-rerun" " rerun.xtc "
29 .BI "\-tpi" " tpi.xvg "
30 .BI "\-tpid" " tpidist.xvg "
31 .BI "\-ei" " sam.edi "
32 .BI "\-eo" " sam.edo "
33 .BI "\-j" " wham.gct "
34 .BI "\-jo" " bam.gct "
35 .BI "\-ffout" " gct.xvg "
36 .BI "\-devout" " deviatie.xvg "
37 .BI "\-runav" " runaver.xvg "
38 .BI "\-px" " pullx.xvg "
39 .BI "\-pf" " pullf.xvg "
40 .BI "\-mtx" " nm.mtx "
41 .BI "\-dn" " dipole.ndx "
42 .BI "\-[no]h" ""
43 .BI "\-[no]version" ""
44 .BI "\-nice" " int "
45 .BI "\-deffnm" " string "
46 .BI "\-xvg" " enum "
47 .BI "\-xyinit" " real "
48 .BI "\-xyend" " real "
49 .BI "\-zinit" " real "
50 .BI "\-zend" " real "
51 .BI "\-nxy" " int "
52 .BI "\-nz" " int "
53 .BI "\-rad" " real "
54 .BI "\-pieces" " int "
55 .BI "\-[no]asymmetry" ""
56 .BI "\-ndiff" " int "
57 .BI "\-maxwarn" " int "
58 .BI "\-[no]compact" ""
59 .BI "\-[no]v" ""
60 .SH DESCRIPTION
61 \&g_membed embeds a membrane protein into an equilibrated lipid bilayer at the position
62 \&and orientation specified by the user.
66 \&SHORT MANUAL
67 \-\-\-\-\-\-\-\-\-\-\-\-
69 \&The user should merge the structure files of the protein and membrane (+solvent), creating a
70 \&single structure file with the protein overlapping the membrane at the desired position and
71 \&orientation. Box size should be taken from the membrane structure file. The corresponding topology
72 \&files should also be merged. Consecutively, create a tpr file (input for g_membed) from these files,with the following options included in the mdp file.
74 \& \- integrator      = md
76 \& \- energygrp       = Protein (or other group that you want to insert)
78 \& \- freezegrps      = Protein
80 \& \- freezedim       = Y Y Y
82 \& \- energygrp_excl  = Protein Protein
84 \&The output is a structure file containing the protein embedded in the membrane. If a topology
85 \&file is provided, the number of lipid and 
86 \&solvent molecules will be updated to match the new structure file.
88 \&For a more extensive manual see Wolf et al, J Comp Chem 31 (2010) 2169\-2174, Appendix.
92 \&SHORT METHOD DESCRIPTION
94 \&\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
96 \&1. The protein is resized around its center of mass by a factor \-xy in the xy\-plane
97 \&(the membrane plane) and a factor \-z in the z\-direction (if the size of the
98 \&protein in the z\-direction is the same or smaller than the width of the membrane, a
99 \&\-z value larger than 1 can prevent that the protein will be enveloped by the lipids).
101 \&2. All lipid and solvent molecules overlapping with the resized protein are removed. All
102 \&intraprotein interactions are turned off to prevent numerical issues for small values of \-xy
103 \& or \-z
105 \&3. One md step is performed.
107 \&4. The resize factor (\-xy or \-z) is incremented by a small amount ((1\-xy)/nxy or (1\-z)/nz) and the
108 \&protein is resized again around its center of mass. The resize factor for the xy\-plane
109 \&is incremented first. The resize factor for the z\-direction is not changed until the \-xy factor
110 \&is 1 (thus after \-nxy iteration).
112 \&5. Repeat step 3 and 4 until the protein reaches its original size (\-nxy + \-nz iterations).
114 \&For a more extensive method descrition see Wolf et al, J Comp Chem, 31 (2010) 2169\-2174.
118 \&NOTE
119 \-\-\-\-
121 \& \- Protein can be any molecule you want to insert in the membrane.
123 \& \- It is recommended to perform a short equilibration run after the embedding
124 \&(see Wolf et al, J Comp Chem 31 (2010) 2169\-2174, to re\-equilibrate the membrane. Clearly
125 \&protein equilibration might require longer.
129 .SH FILES
130 .BI "\-f" " into_mem.tpr" 
131 .B Input
132  Run input file: tpr tpb tpa 
134 .BI "\-n" " index.ndx" 
135 .B Input, Opt.
136  Index file 
138 .BI "\-p" " topol.top" 
139 .B In/Out, Opt.
140  Topology file 
142 .BI "\-o" " traj.trr" 
143 .B Output
144  Full precision trajectory: trr trj cpt 
146 .BI "\-x" " traj.xtc" 
147 .B Output, Opt.
148  Compressed trajectory (portable xdr format) 
150 .BI "\-cpi" " state.cpt" 
151 .B Input, Opt.
152  Checkpoint file 
154 .BI "\-cpo" " state.cpt" 
155 .B Output, Opt.
156  Checkpoint file 
158 .BI "\-c" " membedded.gro" 
159 .B Output
160  Structure file: gro g96 pdb etc. 
162 .BI "\-e" " ener.edr" 
163 .B Output
164  Energy file 
166 .BI "\-g" " md.log" 
167 .B Output
168  Log file 
170 .BI "\-ei" " sam.edi" 
171 .B Input, Opt.
172  ED sampling input 
174 .BI "\-rerun" " rerun.xtc" 
175 .B Input, Opt.
176  Trajectory: xtc trr trj gro g96 pdb cpt 
178 .BI "\-table" " table.xvg" 
179 .B Input, Opt.
180  xvgr/xmgr file 
182 .BI "\-tablep" " tablep.xvg" 
183 .B Input, Opt.
184  xvgr/xmgr file 
186 .BI "\-tableb" " table.xvg" 
187 .B Input, Opt.
188  xvgr/xmgr file 
190 .BI "\-dhdl" " dhdl.xvg" 
191 .B Output, Opt.
192  xvgr/xmgr file 
194 .BI "\-field" " field.xvg" 
195 .B Output, Opt.
196  xvgr/xmgr file 
198 .BI "\-table" " table.xvg" 
199 .B Input, Opt.
200  xvgr/xmgr file 
202 .BI "\-tablep" " tablep.xvg" 
203 .B Input, Opt.
204  xvgr/xmgr file 
206 .BI "\-tableb" " table.xvg" 
207 .B Input, Opt.
208  xvgr/xmgr file 
210 .BI "\-rerun" " rerun.xtc" 
211 .B Input, Opt.
212  Trajectory: xtc trr trj gro g96 pdb cpt 
214 .BI "\-tpi" " tpi.xvg" 
215 .B Output, Opt.
216  xvgr/xmgr file 
218 .BI "\-tpid" " tpidist.xvg" 
219 .B Output, Opt.
220  xvgr/xmgr file 
222 .BI "\-ei" " sam.edi" 
223 .B Input, Opt.
224  ED sampling input 
226 .BI "\-eo" " sam.edo" 
227 .B Output, Opt.
228  ED sampling output 
230 .BI "\-j" " wham.gct" 
231 .B Input, Opt.
232  General coupling stuff 
234 .BI "\-jo" " bam.gct" 
235 .B Output, Opt.
236  General coupling stuff 
238 .BI "\-ffout" " gct.xvg" 
239 .B Output, Opt.
240  xvgr/xmgr file 
242 .BI "\-devout" " deviatie.xvg" 
243 .B Output, Opt.
244  xvgr/xmgr file 
246 .BI "\-runav" " runaver.xvg" 
247 .B Output, Opt.
248  xvgr/xmgr file 
250 .BI "\-px" " pullx.xvg" 
251 .B Output, Opt.
252  xvgr/xmgr file 
254 .BI "\-pf" " pullf.xvg" 
255 .B Output, Opt.
256  xvgr/xmgr file 
258 .BI "\-mtx" " nm.mtx" 
259 .B Output, Opt.
260  Hessian matrix 
262 .BI "\-dn" " dipole.ndx" 
263 .B Output, Opt.
264  Index file 
266 .SH OTHER OPTIONS
267 .BI "\-[no]h"  "no    "
268  Print help info and quit
270 .BI "\-[no]version"  "no    "
271  Print version info and quit
273 .BI "\-nice"  " int" " 0" 
274  Set the nicelevel
276 .BI "\-deffnm"  " string" " " 
277  Set the default filename for all file options
279 .BI "\-xvg"  " enum" " xmgrace" 
280  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
282 .BI "\-xyinit"  " real" " 0.5   " 
283  Resize factor for the protein in the xy dimension before starting embedding
285 .BI "\-xyend"  " real" " 1     " 
286  Final resize factor in the xy dimension
288 .BI "\-zinit"  " real" " 1     " 
289  Resize factor for the protein in the z dimension before starting embedding
291 .BI "\-zend"  " real" " 1     " 
292  Final resize faction in the z dimension
294 .BI "\-nxy"  " int" " 1000" 
295  Number of iteration for the xy dimension
297 .BI "\-nz"  " int" " 0" 
298  Number of iterations for the z dimension
300 .BI "\-rad"  " real" " 0.22  " 
301  Probe radius to check for overlap between the group to embed and the membrane
303 .BI "\-pieces"  " int" " 1" 
304  Perform piecewise resize. Select parts of the group to insert and resize these with respect to their own geometrical center.
306 .BI "\-[no]asymmetry"  "no    "
307  Allow asymmetric insertion, i.e. the number of lipids removed from the upper and lower leaflet will not be checked.
309 .BI "\-ndiff"  " int" " 0" 
310  Number of lipids that will additionally be removed from the lower (negative number) or upper (positive number) membrane leaflet.
312 .BI "\-maxwarn"  " int" " 0" 
313  Maximum number of warning allowed
315 .BI "\-[no]compact"  "yes   "
316  Write a compact log file
318 .BI "\-[no]v"  "no    "
319  Be loud and noisy
321 .SH SEE ALSO
322 .BR gromacs(7)
324 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.