6579c7c00834f4fd85431a6fafb5e629a1c0bbeb
[alexxy/gromacs.git] / docs / user-guide / flow.rst
1 Flow Chart
2 ==========
3
4 This is a flow chart of a typical GROMACS MD run of a protein
5 in a box of water.
6 A more detailed example is available in :doc:`getting-started`.
7 Several steps of energy minimization may be necessary,
8 these consist of cycles: :ref:`gmx grompp` -> :ref:`gmx mdrun`.
9
10 .. raw:: html
11
12    <CENTER>
13    <TABLE BORDER=0 CELLMARGIN=0 CELLPADDING=0 CELLSPACING=0>
14
15    <TR>
16    <TD COLSPAN="2" STYLE="text-align:right"> <A HREF="file-formats.html#pdb" onMouseOver="window.status='Protein Databank file'; return true">eiwit.pdb</A></TD>
17    <TD STYLE="text-align:right"><IMG SRC=../images/flow_leftrightdown.gif></TD>
18    <TD></TD>
19    <TD></TD>
20    <TD></TD>
21    </TR>
22
23    <TR>
24    <TD COLSPAN=2>Generate a GROMACS topology </TD>
25    <TD></TD>
26    <TD BGCOLOR=#777777 COLSPAN=3 STYLE="text-align:center"><A HREF=../programs/gmx-pdb2gmx.html onMouseOver="window.status='Convert PDB file to GROMAX coordinate file and topology'; return true"><B>gmx pdb2gmx</B></A></TD>
27    <TD><IMG SRC=../images/flow_vrule.gif></TD>
28    </TR>
29
30
31    <TR>
32    <TD></TD>
33    <TD></TD>
34    <TD></TD>
35    <TD STYLE="text-align:center"><IMG SRC=../images/flow_vline.gif BORDER=0></TD>
36    <TD WIDTH=20></TD>
37    <TD STYLE="text-align:center"><IMG SRC=../images/flow_vline.gif></TD>
38    </TR>
39
40    <TR>
41    <TD></TD>
42    <TD></TD>
43    <TD></TD>
44    <TD STYLE="text-align:center"><A HREF="file-formats.html#gro" onMouseOver="window.status='GROMACS coordinate file containing molecules from PDB file'; return true">conf.gro</A></TD>
45    <TD></TD>
46    <TD STYLE="text-align:center"> <A HREF="file-formats.html#top" onMouseOver="window.status='GROMACS ascii topology file'; return true">topol.top</A> </TD>
47    </TR>
48
49    <TR>
50    <TD></TD>
51    <TD></TD>
52    <TD></TD>
53    <TD STYLE="text-align:center"><IMG SRC=../images/flow_down.gif BORDER=0></TD>
54    <TD></TD>
55    <TD ROWSPAN=5 COLSPAN=1 STYLE="text-align:center"><IMG SRC=../images/flow_vline.gif><BR><IMG SRC=../images/flow_vline.gif><BR><IMG SRC=../images/flow_vline.gif><BR><IMG SRC=../images/flow_vline.gif><BR><IMG SRC=../images/flow_down.gif></TD>
56    </TR>
57
58    <TR>
59    <TD COLSPAN=2>Enlarge the box</TD>
60    <TD></TD>
61    <TD STYLE="text-align:center" BGCOLOR=#777777><A HREF=../programs/gmx-editconf.html onMouseOver="window.status='Adjust boxsize and placement of molecule'; return true"><B>gmx editconf</B></A></TD>
62    <TD></TD>
63    <TD><IMG SRC=../images/flow_vrule.gif></TD>
64    </TR>
65
66    <TR>
67    <TD></TD>
68    <TD></TD>
69    <TD></TD>
70    <TD STYLE="text-align:center"><IMG SRC=../images/flow_vline.gif></TD>
71    <TD></TD>
72    </TR>
73
74    <TR>
75    <TD></TD>
76    <TD></TD>
77    <TD></TD>
78    <TD STYLE="text-align:center"> <A HREF="file-formats.html#gro" onMouseOver="window.status='GROMACS coordinate file with adjusted box etc.'; return true">conf.gro</A> </TD>
79    <TD></TD>
80    </TR>
81
82
83    <TR>
84    <TD></TD>
85    <TD></TD>
86    <TD></TD>
87    <TD STYLE="text-align:center"><IMG SRC=../images/flow_down.gif></TD>
88    <TD></TD>
89    </TR>
90
91    <TR>
92    <TD COLSPAN=2>Solvate protein</TD>
93    <TD></TD>
94    <TD COLSPAN=3 STYLE="text-align:center" BGCOLOR=#777777>&nbsp;<A HREF=../programs/gmx-solvate.html onMouseOver="window.status='Fill box with water (solvate molecule)'; return true"><B>gmx solvate</B></A>&nbsp;</TD>
95    <TD><IMG SRC=../images/flow_vrule.gif></TD>
96    </TR>
97
98    <TR>
99    <TD></TD>
100    <TD></TD>
101    <TD></TD>
102    <TD STYLE="text-align:center"><IMG SRC=../images/flow_vline.gif></TD>
103    <TD></TD>
104    <TD STYLE="text-align:center"><IMG SRC=../images/flow_vline.gif></TD>
105    </TR>
106
107    <TR>
108    <TD></TD>
109    <TD></TD>
110    <TD></TD>
111    <TD STYLE="text-align:center"><A HREF="file-formats.html#gro" onMouseOver="window.status='GROMACS coordinate file with water molecules added'; return true">conf.gro</A></TD>
112    <TD></TD>
113    <TD STYLE="text-align:center"> <A HREF="file-formats.html#top" onMouseOver="window.status='GROMACS ascii topology file with water molecules added'; return true">topol.top</A> </TD>
114    </TR>
115
116    <TR>
117    <TD COLSPAN=2 STYLE="text-align:right"><A HREF="file-formats.html#mdp" onMouseOver="window.status='Parameter file for grompp (controls all MD parameters)'; return true">grompp.mdp</A></TD>
118    <TD STYLE="text-align:right">&nbsp;<IMG SRC=../images/flow_leftrightdown.gif></TD>
119    <TD STYLE="text-align:center"><IMG SRC=../images/flow_down.gif></TD>
120    <TD></TD>
121    <TD STYLE="text-align:center"><IMG SRC=../images/flow_down.gif></TD>
122    <TD></TD>
123    </TR>
124
125
126    <TR>
127    <TD COLSPAN=2>Generate mdrun input file</TD>
128    <TD></TD>
129    <TD COLSPAN=3 STYLE="text-align:center" BGCOLOR=#777777><A HREF=../programs/gmx-grompp.html onMouseOver="window.status='Process parameters, coordinates and topology and write binary topology'; return true"><B>gmx grompp</B></A></TD>
130    <TD><IMG SRC=../images/flow_vrule.gif></TD>
131    <TD></TD>
132    <TD></TD>
133    </TR>
134
135    <TR>
136    <TD></TD>
137    <TD></TD>
138    <TD></TD>
139    <TD></TD>
140    <TD STYLE="text-align:center"><IMG SRC=../images/flow_vline.gif></TD>
141    <TD ROWSPAN=3 STYLE="text-align:right"><IMG SRC=../images/flow_rightleftdown.gif></TD>
142    <TD STYLE="text-align:center;vertical-align:bottom">Continuation</TD>
143    </TR>
144
145    <TR>
146    <TD COLSPAN=2></TD>
147    <TD></TD>
148    <TD COLSPAN=3 STYLE="text-align:center"> <A HREF="file-formats.html#tpr" onMouseOver="window.status='Portable GROMACS binary run input file (contains all information to start MD run)'; return true">topol.tpr</A></TD>
149    <TD STYLE="text-align:center"><A HREF="file-formats.html#cpt" onMouseOver="window.status='Checkpoint file'; return true">state.cpt</A></TD>
150    </TR>
151
152    <TR>
153    <TD></TD>
154    <TD></TD>
155    <TD></TD>
156    <TD></TD>
157    <TD STYLE="text-align:center"><IMG SRC=../images/flow_down.gif></TD>
158    <TD ROWSPAN=2 STYLE="text-align:center">
159    <IMG SRC=../images/flow_vline.gif><BR>
160    <IMG SRC=../images/flow_leftup.gif></TD>
161    </TR>
162
163    <TR>
164    <TD COLSPAN=2>Run the simulation (EM or MD)</TD>
165    <TD></TD>
166    <TD  COLSPAN=3 STYLE="text-align:center" BGCOLOR=#777777>&nbsp;<A HREF=../programs/gmx-mdrun.html onMouseOver="window.status='The moment you have all been waiting for! START YOUR MD RUN'; return true"><B>gmx mdrun</B></A>&nbsp;</TD>
167    <TD></TD>
168    </TR>
169
170    <TR>
171    <TD></TD>
172    <TD></TD>
173    <TD></TD>
174    <TD STYLE="text-align:center"><IMG SRC=../images/flow_vline.gif></TD>
175    <TD></TD>
176    <TD STYLE="text-align:center"><IMG SRC=../images/flow_vline.gif></TD>
177    </TR>
178
179    <TR>
180    <TD></TD>
181    <TD></TD>
182    <TD></TD>
183    <TD STYLE="text-align:center"> <A HREF="file-formats.html#xtc" onMouseOver="window.status='Portable compressed trajectory'; return true">traj.xtc</A> /
184    <A HREF="file-formats.html#trr" onMouseOver="window.status='Full precision portable trajectory'; return true">traj.trr</A> </TD>
185    <TD></TD>
186    <TD STYLE="text-align:center"> <A HREF="file-formats.html#edr" onMouseOver="window.status='Portable energy file'; return true">ener.edr</A> </TD>
187    </TR>
188
189    <TR>
190    <TD></TD>
191    <TD></TD>
192    <TD></TD>
193    <TD STYLE="text-align:center"><IMG SRC=../images/flow_down.gif></TD>
194    <TD></TD>
195    <TD STYLE="text-align:center"><IMG SRC=../images/flow_down.gif></TD>
196    </TR>
197
198    <TR>
199    <TD COLSPAN=2>Analysis</TD>
200    <TD></TD>
201    <TD STYLE="text-align:center" BGCOLOR=#777777><A HREF="../programs/bytopic.html" onMouseOver="window.status='Your favourite GROMACS analysis tool'; return true"><B>g_...</B></A><BR><A HREF=../programs/gmx-view.html onMouseOver="window.status='gmx view, the GROMACS trajectory viewer'; return true"><B>gmx view</B></A></TD>
202    <TD></TD>
203    <TD STYLE="text-align:center" BGCOLOR=#777777><A HREF=../programs/gmx-energy.html onMouseOver="window.status='Energy plots, averages and  fluctuations'; return true"><B>gmx energy</B></A></TD>
204    <TD><IMG SRC=../images/flow_vrule.gif></TD>
205    </TR>
206
207
208    </TABLE>
209    </CENTER>
210