New entry
[gromacs/rigid-bodies.git] / man / man1 / g_membed.1
blob00702588ea18ed5db593403af1f56d09ef0b00de
1 .TH g_membed 1 "Mon 4 Apr 2011" "" "GROMACS suite, VERSION 4.5.4-dev-20110404-bc5695c"
2 .SH NAME
3 g_membed - embeds a protein into a lipid bilayer
5 .B VERSION 4.5.4-dev-20110404-bc5695c
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 "\-multidir" " rundir "
43 .BI "\-[no]h" ""
44 .BI "\-[no]version" ""
45 .BI "\-nice" " int "
46 .BI "\-deffnm" " string "
47 .BI "\-xvg" " enum "
48 .BI "\-xyinit" " real "
49 .BI "\-xyend" " real "
50 .BI "\-zinit" " real "
51 .BI "\-zend" " real "
52 .BI "\-nxy" " int "
53 .BI "\-nz" " int "
54 .BI "\-rad" " real "
55 .BI "\-pieces" " int "
56 .BI "\-[no]asymmetry" ""
57 .BI "\-ndiff" " int "
58 .BI "\-maxwarn" " int "
59 .BI "\-[no]compact" ""
60 .BI "\-[no]v" ""
61 .SH DESCRIPTION
62 \&\fB g_membed\fR embeds a membrane protein into an equilibrated lipid bilayer at the position
63 \&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. The box size is taken from the membrane structure file. The corresponding topology
72 \&files should also be merged. Consecutively, create a \fB .tpr\fR file (input for \fB g_membed\fR) from these files,with the following options included in the \fB .mdp\fR file.
74 \& \- \fB integrator      = md\fR
76 \& \- \fB energygrp       = Protein\fR (or other group that you want to insert)
78 \& \- \fB freezegrps      = Protein\fR
80 \& \- \fB freezedim       = Y Y Y\fR
82 \& \- \fB energygrp_excl  = Protein Protein\fR
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.
91 \&SHORT METHOD DESCRIPTION
93 \&\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
95 \&1. The protein is resized around its center of mass by a factor \fB \-xy\fR in the xy\-plane
96 \&(the membrane plane) and a factor \fB \-z\fR in the \fI z\fR\-direction (if the size of the
97 \&protein in the z\-direction is the same or smaller than the width of the membrane, a
98 \&\fB \-z\fR value larger than 1 can prevent that the protein will be enveloped by the lipids).
100 \&2. All lipid and solvent molecules overlapping with the resized protein are removed. All
101 \&intraprotein interactions are turned off to prevent numerical issues for small values of \fB \-xy\fR
102 \& or \fB \-z\fR
104 \&3. One md step is performed.
106 \&4. The resize factor (\fB \-xy\fR or \fB \-z\fR) is incremented by a small amount ((1\-xy)/nxy or (1\-z)/nz) and the
107 \&protein is resized again around its center of mass. The resize factor for the xy\-plane
108 \&is incremented first. The resize factor for the z\-direction is not changed until the \fB \-xy\fR factor
109 \&is 1 (thus after \fB \-nxy\fR iterations).
111 \&5. Repeat step 3 and 4 until the protein reaches its original size (\fB \-nxy\fR + \fB \-nz\fR iterations).
113 \&For a more extensive method description see Wolf et al, J Comp Chem, 31 (2010) 2169\-2174.
116 \&NOTE
117 \-\-\-\-
119 \& \- Protein can be any molecule you want to insert in the membrane.
121 \& \- It is recommended to perform a short equilibration run after the embedding
122 \&(see Wolf et al, J Comp Chem 31 (2010) 2169\-2174), to re\-equilibrate the membrane. Clearly
123 \&protein equilibration might require longer.
126 .SH FILES
127 .BI "\-f" " into_mem.tpr" 
128 .B Input
129  Run input file: tpr tpb tpa 
131 .BI "\-n" " index.ndx" 
132 .B Input, Opt.
133  Index file 
135 .BI "\-p" " topol.top" 
136 .B In/Out, Opt.
137  Topology file 
139 .BI "\-o" " traj.trr" 
140 .B Output
141  Full precision trajectory: trr trj cpt 
143 .BI "\-x" " traj.xtc" 
144 .B Output, Opt.
145  Compressed trajectory (portable xdr format) 
147 .BI "\-cpi" " state.cpt" 
148 .B Input, Opt.
149  Checkpoint file 
151 .BI "\-cpo" " state.cpt" 
152 .B Output, Opt.
153  Checkpoint file 
155 .BI "\-c" " membedded.gro" 
156 .B Output
157  Structure file: gro g96 pdb etc. 
159 .BI "\-e" " ener.edr" 
160 .B Output
161  Energy file 
163 .BI "\-g" " md.log" 
164 .B Output
165  Log file 
167 .BI "\-ei" " sam.edi" 
168 .B Input, Opt.
169  ED sampling input 
171 .BI "\-rerun" " rerun.xtc" 
172 .B Input, Opt.
173  Trajectory: xtc trr trj gro g96 pdb cpt 
175 .BI "\-table" " table.xvg" 
176 .B Input, Opt.
177  xvgr/xmgr file 
179 .BI "\-tablep" " tablep.xvg" 
180 .B Input, Opt.
181  xvgr/xmgr file 
183 .BI "\-tableb" " table.xvg" 
184 .B Input, Opt.
185  xvgr/xmgr file 
187 .BI "\-dhdl" " dhdl.xvg" 
188 .B Output, Opt.
189  xvgr/xmgr file 
191 .BI "\-field" " field.xvg" 
192 .B Output, Opt.
193  xvgr/xmgr file 
195 .BI "\-table" " table.xvg" 
196 .B Input, Opt.
197  xvgr/xmgr file 
199 .BI "\-tablep" " tablep.xvg" 
200 .B Input, Opt.
201  xvgr/xmgr file 
203 .BI "\-tableb" " table.xvg" 
204 .B Input, Opt.
205  xvgr/xmgr file 
207 .BI "\-rerun" " rerun.xtc" 
208 .B Input, Opt.
209  Trajectory: xtc trr trj gro g96 pdb cpt 
211 .BI "\-tpi" " tpi.xvg" 
212 .B Output, Opt.
213  xvgr/xmgr file 
215 .BI "\-tpid" " tpidist.xvg" 
216 .B Output, Opt.
217  xvgr/xmgr file 
219 .BI "\-ei" " sam.edi" 
220 .B Input, Opt.
221  ED sampling input 
223 .BI "\-eo" " sam.edo" 
224 .B Output, Opt.
225  ED sampling output 
227 .BI "\-j" " wham.gct" 
228 .B Input, Opt.
229  General coupling stuff 
231 .BI "\-jo" " bam.gct" 
232 .B Output, Opt.
233  General coupling stuff 
235 .BI "\-ffout" " gct.xvg" 
236 .B Output, Opt.
237  xvgr/xmgr file 
239 .BI "\-devout" " deviatie.xvg" 
240 .B Output, Opt.
241  xvgr/xmgr file 
243 .BI "\-runav" " runaver.xvg" 
244 .B Output, Opt.
245  xvgr/xmgr file 
247 .BI "\-px" " pullx.xvg" 
248 .B Output, Opt.
249  xvgr/xmgr file 
251 .BI "\-pf" " pullf.xvg" 
252 .B Output, Opt.
253  xvgr/xmgr file 
255 .BI "\-mtx" " nm.mtx" 
256 .B Output, Opt.
257  Hessian matrix 
259 .BI "\-dn" " dipole.ndx" 
260 .B Output, Opt.
261  Index file 
263 .BI "\-multidir" " rundir" 
264 .B Input, Opt., Mult.
265  Run directory 
267 .SH OTHER OPTIONS
268 .BI "\-[no]h"  "no    "
269  Print help info and quit
271 .BI "\-[no]version"  "no    "
272  Print version info and quit
274 .BI "\-nice"  " int" " 0" 
275  Set the nicelevel
277 .BI "\-deffnm"  " string" " " 
278  Set the default filename for all file options
280 .BI "\-xvg"  " enum" " xmgrace" 
281  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
283 .BI "\-xyinit"  " real" " 0.5   " 
284  Resize factor for the protein in the xy dimension before starting embedding
286 .BI "\-xyend"  " real" " 1     " 
287  Final resize factor in the xy dimension
289 .BI "\-zinit"  " real" " 1     " 
290  Resize factor for the protein in the z dimension before starting embedding
292 .BI "\-zend"  " real" " 1     " 
293  Final resize faction in the z dimension
295 .BI "\-nxy"  " int" " 1000" 
296  Number of iteration for the xy dimension
298 .BI "\-nz"  " int" " 0" 
299  Number of iterations for the z dimension
301 .BI "\-rad"  " real" " 0.22  " 
302  Probe radius to check for overlap between the group to embed and the membrane
304 .BI "\-pieces"  " int" " 1" 
305  Perform piecewise resize. Select parts of the group to insert and resize these with respect to their own geometrical center.
307 .BI "\-[no]asymmetry"  "no    "
308  Allow asymmetric insertion, i.e. the number of lipids removed from the upper and lower leaflet will not be checked.
310 .BI "\-ndiff"  " int" " 0" 
311  Number of lipids that will additionally be removed from the lower (negative number) or upper (positive number) membrane leaflet.
313 .BI "\-maxwarn"  " int" " 0" 
314  Maximum number of warning allowed
316 .BI "\-[no]compact"  "yes   "
317  Write a compact log file
319 .BI "\-[no]v"  "no    "
320  Be loud and noisy
322 .SH SEE ALSO
323 .BR gromacs(7)
325 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.