docs/gmxapi/index.rst

   1 .. _gmxapi:
   2
   3 =====================
   4 gmxapi Python package
   5 =====================
   6
   7 This documentation is part of the `GROMACS manual <http://manual.gromacs.org/current/>`_
   8 and describes the *gmxapi* Python package.
   9 :py:mod:`gmxapi` allows molecular simulation and analysis work to
  10 be staged and run from Python.
  11
  12 From version 0.1, the latest official documentation is at http://manual.gromacs.org/current/gmxapi/.
  13 Other releases can also be found at `GitHub <https://www.github.com/kassonlab/gmxapi>`_.
  14
  15 ..  toctree::
  16     :maxdepth: 2
  17     :caption: Documentation sections
  18
  19     userguide/userguide.rst
  20
  21 .. seealso::
  22
  23     gmxapi was first described by
  24
  25     Irrgang, M. E., Hays, J. M., & Kasson, P. M.
  26     gmxapi: a high-level interface for advanced control and extension of molecular dynamics simulations.
  27     *Bioinformatics* 2018.
  28     DOI: `10.1093/bioinformatics/bty484 <https://doi.org/10.1093/bioinformatics/bty484>`_
  29
  30 Indices and tables
  31 ==================
  32
  33 * :ref:`genindex`
  34 * :ref:`search`