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 .. digraph:: flowchart
  11
  12    node [ shape=box, width=1.5 ]
  13
  14    input_pdb [
  15      label="eiwit.pdb"
  16      tooltip="Protein Databank file"
  17      URL="file-formats.html#pdb"
  18      shape=none, width=0, height=0, margin=0
  19      group=input
  20    ]
  21    pdb2gmx [
  22      label="Generate a GROMACS topology\ngmx pdb2gmx"
  23      tooltip="Convert PDB file to GROMACS coordinate file and topology"
  24      URL="../onlinehelp/gmx-pdb2gmx.html"
  25      width=3
  26      group=main
  27    ]
  28
  29    input_pdb -> pdb2gmx [ headport=e ]
  30
  31    editconf [
  32      label="Enlarge the box\ngmx editconf"
  33      tooltip="Adjust box size and placement of molecule"
  34      URL="../onlinehelp/gmx-editconf.html"
  35    ]
  36
  37    pdb2gmx -> editconf [
  38      label="conf.gro"
  39      labeltooltip="GROMACS coordinate file containing molecules from PDB file"
  40      URL="file-formats.html#gro"
  41    ]
  42
  43    solvate [
  44      label="Solvate protein\ngmx solvate"
  45      tooltip="Fill box with water (solvate molecule)"
  46      URL="../onlinehelp/gmx-solvate.html"
  47      width=3
  48      group=main
  49    ]
  50
  51    pdb2gmx -> solvate [
  52      label="topol.top"
  53      labeltooltip="GROMACS ascii topology file"
  54      URL="file-formats.html#top"
  55    ]
  56    editconf -> solvate [
  57      label="conf.gro"
  58      labeltooltip="GROMACS coordinate file with adjusted box etc."
  59      URL="file-formats.html#gro"
  60    ]
  61
  62    input_mdp [
  63      label="grompp.mdp"
  64      tooltip="Parameter file from grompp (controls all MD parameters)"
  65      URL="file-formats.html#mdp"
  66      shape=none, width=0, height=0, margin=0
  67      group=input
  68    ]
  69    grompp [
  70      label="Generate mdrun input file\ngmx grompp"
  71      tooltip="Process parameters, coordinates and topology and write binary topology"
  72      URL="../onlinehelp/gmx-grompp.html"
  73      width=3
  74      group=main
  75    ]
  76
  77    input_pdb -> input_mdp [ style=invis, minlen=3 ]
  78
  79    input_mdp -> grompp [ headport=e, weight=0 ]
  80    solvate -> grompp [
  81      label="conf.gro"
  82      labeltooltip="GROMACS coordinate file with water molecules added"
  83      URL="file-formats.html#gro"
  84    ]
  85    solvate -> grompp [
  86      label="topol.top"
  87      labeltooltip="GROMACS ascii topology file with water molecules added"
  88      URL="file-formats.html#top"
  89    ]
  90
  91    mdrun [
  92      label="Run the simulation (EM or MD)\ngmx mdrun"
  93      tooltip="The moment you have all been waiting for! START YOUR MD RUN"
  94      URL="../onlinehelp/gmx-mdrun.html"
  95      width=3
  96      group=main
  97    ]
  98
  99    grompp -> mdrun [
 100      label="topol.tpr"
 101      labeltooltip="Portable GROMACS binary run input file (contains all information to start MD run)"
 102      URL="file-formats.html#tpr"
 103    ]
 104    mdrun -> mdrun [
 105      label="Continuation\nstate.cpt"
 106      labeltooltip="Checkpoint file"
 107      URL="file-formats.html#cpt"
 108    ]
 109
 110    analysis [
 111      label="Analysis\ngmx ...\ngmx view"
 112      tooltip="Your favourite GROMACS analysis tool"
 113      URL="../onlinehelp/bytopic.html"
 114    ]
 115
 116    mdrun -> analysis [
 117      label="traj.xtc / traj.trr"
 118      labeltooltip="Portable compressed trajectory / full precision portable trajectory"
 119      URL="file-formats.html#xtc"
 120    ]
 121
 122    energy [
 123      label="Analysis\ngmx energy"
 124      tooltip="Energy plots, averages and fluctuations"
 125      URL="../onlinehelp/gmx-energy.html"
 126    ]
 127
 128    mdrun -> energy [
 129      label="ener.edr"
 130      labeltooltip="Portable energy file"
 131      URL="file-formats.html#edr"
 132    ]