From: Teemu Murtola Date: Tue, 12 May 2015 11:37:54 +0000 (+0300) Subject: Remove remaining old-html content X-Git-Url: http://biod.pnpi.spb.ru/gitweb/?a=commitdiff_plain;h=fd397bbc7744e9dcb3728f0c2e6f7372e6d74019;p=alexxy%2Fgromacs.git Remove remaining old-html content Replace the HTML table hack + static images that created the flow chart with a graphviz graph. The presentation could potentially be improved, but the essential content from the old chart is there (in case it is useful). Remove all build system references to old-html, simplifying the system and removing the need to document any of this. Change-Id: Ic011c770676d4d6d1b560fcb521bfc523c142ad0 --- diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 8197b4fced..9f48109107 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -299,13 +299,6 @@ if(GMX_BUILD_WEBPAGE) endif() endif() -# TODO Get rid of the remaining content in old-html -add_custom_target(webpage-old-images - ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/old-html ${HTML_OUTPUT_DIR} - COMMENT "Copying flowchart images" - VERBATIM - ) - if(HTML_BUILD_IS_POSSIBLE) # Make the PDF reference guide # TODO Try to make the PDF arrive directly in ${HTML_OUTPUT_DIR} @@ -327,12 +320,8 @@ if(HTML_BUILD_IS_POSSIBLE) # Add a top-level target for the others to hook onto add_custom_target(webpage - DEPENDS - ${HTML_OUTPUT_DIR}/manual-${GMX_VERSION_STRING}.pdf - ${extra_webpage_dependencies} - VERBATIM - ) - add_dependencies(webpage webpage-sphinx webpage-old-images doxygen-all) + DEPENDS ${HTML_OUTPUT_DIR}/manual-${GMX_VERSION_STRING}.pdf) + add_dependencies(webpage webpage-sphinx doxygen-all) else() add_custom_target(webpage COMMAND ${CMAKE_COMMAND} -E echo "Cannot build webpage because of missing requirements. Check cmake status output for reasons" diff --git a/docs/conf.py b/docs/conf.py index a7b172b5d6..8a63cd7c43 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -66,6 +66,7 @@ sys.path.append(gmx_sphinx_extension_path) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx.ext.graphviz', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig', 'gmxsphinx' diff --git a/docs/old-html/images/flow_down.gif b/docs/old-html/images/flow_down.gif deleted file mode 100644 index 5944f8a65e..0000000000 Binary files a/docs/old-html/images/flow_down.gif and /dev/null differ diff --git a/docs/old-html/images/flow_downleft.gif b/docs/old-html/images/flow_downleft.gif deleted file mode 100644 index 9881edad97..0000000000 Binary files a/docs/old-html/images/flow_downleft.gif and /dev/null differ diff --git a/docs/old-html/images/flow_hline.gif b/docs/old-html/images/flow_hline.gif deleted file mode 100644 index ab236cc6f6..0000000000 Binary files a/docs/old-html/images/flow_hline.gif and /dev/null differ diff --git a/docs/old-html/images/flow_left.gif b/docs/old-html/images/flow_left.gif deleted file mode 100644 index 6cf841ae03..0000000000 Binary files a/docs/old-html/images/flow_left.gif and /dev/null differ diff --git a/docs/old-html/images/flow_leftright.gif b/docs/old-html/images/flow_leftright.gif deleted file mode 100644 index 38c3acb2d3..0000000000 Binary files a/docs/old-html/images/flow_leftright.gif and /dev/null differ diff --git a/docs/old-html/images/flow_leftrightdown.gif b/docs/old-html/images/flow_leftrightdown.gif deleted file mode 100644 index 851d516157..0000000000 Binary files a/docs/old-html/images/flow_leftrightdown.gif and /dev/null differ diff --git a/docs/old-html/images/flow_leftrightup.gif b/docs/old-html/images/flow_leftrightup.gif deleted file mode 100644 index fb90440ebf..0000000000 Binary files a/docs/old-html/images/flow_leftrightup.gif and /dev/null differ diff --git a/docs/old-html/images/flow_leftup.gif b/docs/old-html/images/flow_leftup.gif deleted file mode 100644 index 49bdefb743..0000000000 Binary files a/docs/old-html/images/flow_leftup.gif and /dev/null differ diff --git a/docs/old-html/images/flow_right+left.gif b/docs/old-html/images/flow_right+left.gif deleted file mode 100644 index 2a649901a2..0000000000 Binary files a/docs/old-html/images/flow_right+left.gif and /dev/null differ diff --git a/docs/old-html/images/flow_right.gif b/docs/old-html/images/flow_right.gif deleted file mode 100644 index 3540effd11..0000000000 Binary files a/docs/old-html/images/flow_right.gif and /dev/null differ diff --git a/docs/old-html/images/flow_rightleftdown.gif b/docs/old-html/images/flow_rightleftdown.gif deleted file mode 100644 index 304edd24ed..0000000000 Binary files a/docs/old-html/images/flow_rightleftdown.gif and /dev/null differ diff --git a/docs/old-html/images/flow_uprightleft.gif b/docs/old-html/images/flow_uprightleft.gif deleted file mode 100644 index f4cbd1e33a..0000000000 Binary files a/docs/old-html/images/flow_uprightleft.gif and /dev/null differ diff --git a/docs/old-html/images/flow_vline.gif b/docs/old-html/images/flow_vline.gif deleted file mode 100644 index 684697a6f5..0000000000 Binary files a/docs/old-html/images/flow_vline.gif and /dev/null differ diff --git a/docs/old-html/images/flow_vrule.gif b/docs/old-html/images/flow_vrule.gif deleted file mode 100644 index 2fa7f17641..0000000000 Binary files a/docs/old-html/images/flow_vrule.gif and /dev/null differ diff --git a/docs/user-guide/flow.rst b/docs/user-guide/flow.rst index 6579c7c008..52d1f817d3 100644 --- a/docs/user-guide/flow.rst +++ b/docs/user-guide/flow.rst @@ -7,204 +7,129 @@ A more detailed example is available in :doc:`getting-started`. Several steps of energy minimization may be necessary, these consist of cycles: :ref:`gmx grompp` -> :ref:`gmx mdrun`. -.. raw:: html - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
eiwit.pdb
Generate a GROMACS topology gmx pdb2gmx
conf.gro topol.top




Enlarge the boxgmx editconf
conf.gro
Solvate protein gmx solvate 
conf.gro topol.top
grompp.mdp 
Generate mdrun input filegmx grompp
Continuation
topol.tprstate.cpt
-
-
Run the simulation (EM or MD) gmx mdrun 
traj.xtc / - traj.trr ener.edr
Analysisg_...
gmx view		gmx energy
-
- +.. URL="file-formats.html#pdb" +.. ../programs/gmx-pdb2gmx.html + +.. digraph:: flowchart + + node [ shape=box, width=1.5 ] + + input_pdb [ + label="eiwit.pdb" + tooltip="Protein Databank file" + URL="file-formats.html#pdb" + shape=none, width=0, height=0, margin=0 + group=input + ] + pdb2gmx [ + label="Generate a GROMACS topology\ngmx pdb2gmx" + tooltip="Convert PDB file to GROMACS coordinate file and topology" + URL="../programs/gmx-pdb2gmx.html" + width=3 + group=main + ] + + input_pdb -> pdb2gmx [ headport=e ] + + editconf [ + label="Enlarge the box\ngmx editconf" + tooltip="Adjust box size and placement of molecule" + URL="../programs/gmx-editconf.html" + ] + + pdb2gmx -> editconf [ + label="conf.gro" + labeltooltip="GROMACS coordinate file containing molecules from PDB file" + URL="file-formats.html#gro" + ] + + solvate [ + label="Solvate protein\ngmx solvate" + tooltip="Fill box with water (solvate molecule)" + URL="../programs/gmx-solvate.html" + width=3 + group=main + ] + + pdb2gmx -> solvate [ + label="topol.top" + labeltooltip="GROMACS ascii topology file" + URL="file-formats.html#top" + ] + editconf -> solvate [ + label="conf.gro" + labeltooltip="GROMACS coordinate file with adjusted box etc." + URL="file-formats.html#gro" + ] + + input_mdp [ + label="grompp.mdp" + tooltip="Parameter file from grompp (controls all MD parameters)" + URL="file-formats.html#mdp" + shape=none, width=0, height=0, margin=0 + group=input + ] + grompp [ + label="Generate mdrun input file\ngmx grompp" + tooltip="Process parameters, coordinates and topology and write binary topology" + URL="../programs/gmx-grompp.html" + width=3 + group=main + ] + + input_pdb -> input_mdp [ style=invis, minlen=3 ] + + input_mdp -> grompp [ headport=e, weight=0 ] + solvate -> grompp [ + label="conf.gro" + labeltooltip="GROMACS coordinate file with water molecules added" + URL="file-formats.html#gro" + ] + solvate -> grompp [ + label="topol.top" + labeltooltip="GROMACS ascii topology file with water molecules added" + URL="file-formats.html#top" + ] + + mdrun [ + label="Run the simulation (EM or MD)\ngmx mdrun" + tooltip="The moment you have all been waiting for! START YOUR MD RUN" + URL="../programs/gmx-mdrun.html" + width=3 + group=main + ] + + grompp -> mdrun [ + label="topol.tpr" + labeltooltip="Portable GROMACS binary run input file (contains all information to start MD run)" + URL="file-formats.html#tpr" + ] + mdrun -> mdrun [ + label="Continuation\nstate.cpt" + labeltooltip="Checkpoint file" + URL="file-formats.html#cpt" + ] + + analysis [ + label="Analysis\ngmx ...\ngmx view" + tooltip="Your favourite GROMACS analysis tool" + URL="../programs/bytopic.html" + ] + + mdrun -> analysis [ + label="traj.xtc / traj.trr" + labeltooltip="Portable compressed trajectory / full precision portable trajectory" + URL="file-formats.html#xtc" + ] + + energy [ + label="Analysis\ngmx energy" + tooltip="Energy plots, averages and fluctuations" + URL="../programs/gmx-energy.html" + ] + + mdrun -> energy [ + label="ener.edr" + labeltooltip="Portable energy file" + URL="file-formats.html#edr" + ]