Properly finalize MPI on mdrun -version. Fixes #1313
[gromacs.git] / share / html / online / g_spatial.html
blob8e4cfb20af91b81791ac9e57f93e2fe9132132b1
1 <HTML>
2 <HEAD>
3 <TITLE>g_spatial</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>g_spatial</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.6<br>
13 Sat 19 Jan 2013</B></td></tr></TABLE>
14 <HR>
15 <H3>Description</H3>
16 <p>
17 <tt>g_spatial</tt> calculates the spatial distribution function and
18 outputs it in a form that can be read by VMD as Gaussian98 cube format.
19 This was developed from template.c (GROMACS-3.3).
20 For a system of 32,000 atoms and a 50 ns trajectory, the SDF can be generated
21 in about 30 minutes, with most of the time dedicated to the two runs through
22 <tt><a href="trjconv.html">trjconv</a></tt> that are required to center everything properly.
23 This also takes a whole bunch of space (3 copies of the <tt>.<a href="xtc.html">xtc</a></tt> file).
24 Still, the pictures are pretty and very informative when the fitted selection is properly made.
25 3-4 atoms in a widely mobile group (like a free amino acid in solution) works
26 well, or select the protein backbone in a stable folded structure to get the SDF
27 of solvent and look at the time-averaged solvation shell.
28 It is also possible using this program to generate the SDF based on some arbitrary
29 Cartesian coordinate. To do that, simply omit the preliminary <tt><a href="trjconv.html">trjconv</a></tt> steps.
31 USAGE:
33 1. Use <tt><a href="make_<a href="ndx.html">ndx</a>.html">make_<a href="ndx.html">ndx</a></a></tt> to create a group containing the atoms around which you want the SDF
35 2. <tt><a href="trjconv.html">trjconv</a> -s a.<a href="tpr.html">tpr</a> -f a.<a href="xtc.html">xtc</a> -o b.<a href="xtc.html">xtc</a> -center tric -ur compact -pbc none</tt>
37 3. <tt><a href="trjconv.html">trjconv</a> -s a.<a href="tpr.html">tpr</a> -f b.<a href="xtc.html">xtc</a> -o c.<a href="xtc.html">xtc</a> -fit rot+trans</tt>
39 4. run <tt>g_spatial</tt> on the <tt>.<a href="xtc.html">xtc</a></tt> output of step #3.
41 5. Load <tt>grid.cube</tt> into VMD and view as an isosurface.
43 <b>Note</b> that systems such as micelles will require <tt><a href="trjconv.html">trjconv</a> -pbc cluster</tt> between steps 1 and 2
45 WARNINGS:<br>
46 The SDF will be generated for a cube that contains all bins that have some non-zero occupancy.
47 However, the preparatory <tt>-fit rot+trans</tt> option to <tt><a href="trjconv.html">trjconv</a></tt> implies that your system will be rotating
48 and translating in space (in order that the selected group does not). Therefore the values that are
49 returned will only be valid for some region around your central group/coordinate that has full overlap
50 with system volume throughout the entire translated/rotated system over the course of the trajectory.
51 It is up to the user to ensure that this is the case.
53 BUGS:<br>
54 When the allocated memory is not large enough, a segmentation fault may occur. This is usually detected
55 and the program is halted prior to the fault while displaying a warning message suggesting the use of the <tt>-nab</tt> (Number of Additional Bins)
56 option. However, the program does not detect all such events. If you encounter a segmentation fault, run it again
57 with an increased <tt>-nab</tt> value.
59 RISKY OPTIONS:<br>
60 To reduce the amount of space and time required, you can output only the coords
61 that are going to be used in the first and subsequent run through <tt><a href="trjconv.html">trjconv</a></tt>.
62 However, be sure to set the <tt>-nab</tt> option to a sufficiently high value since
63 memory is allocated for cube bins based on the initial coordinates and the <tt>-nab</tt>
64 option value.
66 <P>
67 <H3>Files</H3>
68 <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=2>
69 <TR><TH>option</TH><TH>filename</TH><TH>type</TH><TH>description</TH></TR>
70 <TR><TD ALIGN=RIGHT> <b><tt>-s</tt></b> </TD><TD ALIGN=RIGHT> <tt><a href="files.html"> topol.tpr</a></tt> </TD><TD> Input </TD><TD> Structure+mass(db): <a href="tpr.html">tpr</a> <a href="tpb.html">tpb</a> <a href="tpa.html">tpa</a> <a href="gro.html">gro</a> <a href="g96.html">g96</a> <a href="pdb.html">pdb</a> </TD></TR>
71 <TR><TD ALIGN=RIGHT> <b><tt>-f</tt></b> </TD><TD ALIGN=RIGHT> <tt><a href="files.html"> traj.xtc</a></tt> </TD><TD> Input </TD><TD> Trajectory: <a href="xtc.html">xtc</a> <a href="trr.html">trr</a> <a href="trj.html">trj</a> <a href="gro.html">gro</a> <a href="g96.html">g96</a> <a href="pdb.html">pdb</a> cpt </TD></TR>
72 <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>
73 </TABLE>
74 <P>
75 <H3>Other options</H3>
76 <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=2>
77 <TR><TH>option</TH><TH>type</TH><TH>default</TH><TH>description</TH></TR>
78 <TR><TD ALIGN=RIGHT> <b><tt>-[no]h</tt></b> </TD><TD ALIGN=RIGHT> bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Print help info and quit </TD></TD>
79 <TR><TD ALIGN=RIGHT> <b><tt>-[no]version</tt></b> </TD><TD ALIGN=RIGHT> bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Print version info and quit </TD></TD>
80 <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>
81 <TR><TD ALIGN=RIGHT> <b><tt>-b</tt></b> </TD><TD ALIGN=RIGHT> time </TD><TD ALIGN=RIGHT> <tt>0 </tt> </TD><TD> First frame (ps) to read from trajectory </TD></TD>
82 <TR><TD ALIGN=RIGHT> <b><tt>-e</tt></b> </TD><TD ALIGN=RIGHT> time </TD><TD ALIGN=RIGHT> <tt>0 </tt> </TD><TD> Last frame (ps) to read from trajectory </TD></TD>
83 <TR><TD ALIGN=RIGHT> <b><tt>-dt</tt></b> </TD><TD ALIGN=RIGHT> time </TD><TD ALIGN=RIGHT> <tt>0 </tt> </TD><TD> Only use frame when t MOD dt = first time (ps) </TD></TD>
84 <TR><TD ALIGN=RIGHT> <b><tt>-[no]w</tt></b> </TD><TD ALIGN=RIGHT> bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> View output <tt>.<a href="xvg.html">xvg</a></tt>, <tt>.<a href="xpm.html">xpm</a></tt>, <tt>.<a href="eps.html">eps</a></tt> and <tt>.<a href="pdb.html">pdb</a></tt> files </TD></TD>
85 <TR><TD ALIGN=RIGHT> <b><tt>-[no]pbc</tt></b> </TD><TD ALIGN=RIGHT> bool </TD><TD ALIGN=RIGHT> <tt>no </tt> </TD><TD> Use periodic boundary conditions for computing distances </TD></TD>
86 <TR><TD ALIGN=RIGHT> <b><tt>-[no]div</tt></b> </TD><TD ALIGN=RIGHT> bool </TD><TD ALIGN=RIGHT> <tt>yes </tt> </TD><TD> Calculate and apply the divisor for bin occupancies based on atoms/minimal cube size. Set as TRUE for visualization and as FALSE (<tt>-nodiv</tt>) to get accurate counts per frame </TD></TD>
87 <TR><TD ALIGN=RIGHT> <b><tt>-ign</tt></b> </TD><TD ALIGN=RIGHT> int </TD><TD ALIGN=RIGHT> <tt>-1</tt> </TD><TD> Do not display this number of outer cubes (positive values may reduce boundary speckles; -1 ensures outer surface is visible) </TD></TD>
88 <TR><TD ALIGN=RIGHT> <b><tt>-bin</tt></b> </TD><TD ALIGN=RIGHT> real </TD><TD ALIGN=RIGHT> <tt>0.05 </tt> </TD><TD> Width of the bins (nm) </TD></TD>
89 <TR><TD ALIGN=RIGHT> <b><tt>-nab</tt></b> </TD><TD ALIGN=RIGHT> int </TD><TD ALIGN=RIGHT> <tt>4</tt> </TD><TD> Number of additional bins to ensure proper memory allocation </TD></TD>
90 </TABLE>
91 <P>
92 <hr>
93 <div ALIGN=RIGHT>
94 <font size="-1"><a href="http://www.gromacs.org">http://www.gromacs.org</a></font><br>
95 <font size="-1"><a href="mailto:gromacs@gromacs.org">gromacs@gromacs.org</a></font><br>
96 </div>
97 </BODY>