docs/user-guide/index.rst

   1 .. _user guide:
   2
   3 **********
   4 User guide
   5 **********
   6
   7 .. highlight:: bash
   8
   9 This guide provides
  10
  11 * material introducing |Gromacs|
  12 * practical advice for making effective use of |Gromacs|.
  13
  14 For getting, building and installing |Gromacs|, see the
  15 :doc:`/install-guide/index`.
  16 For background on algorithms and implementations, see the
  17 :ref:`reference manual part <gmx-reference-manual-rst>` of the documentation.
  18 If you have questions not answered by these resources,
  19 please visit the `GROMACS users forum <https://gromacs.bioexcel.eu/>`_
  20 and search for a potential answer or ask a question from the community.
  21
  22 |GMX_MANUAL_DOI_STRING|
  23
  24 |GMX_SOURCE_DOI_STRING|
  25
  26 .. todo::
  27
  28    This is going to require more organization now that
  29    we are getting more content available.
  30
  31 .. toctree::
  32    :maxdepth: 2
  33
  34    known-issues
  35    getting-started
  36    system-preparation
  37    managing-simulations
  38    faq
  39    force-fields
  40    mdp-options
  41    mdrun-features
  42    mdrun-performance
  43    run-time-errors
  44    cmdline
  45    terminology
  46    environment-variables
  47    floating-point
  48    security
  49    deprecation-policy