=================
Python User Guide
=================

.. toctree::
    :maxdepth: 2

    install
    usage
    pythonreference

After installing GROMACS and the gmxapi Python package, use ``pydoc gmxapi``
from the command line or ``import gmxapi; help(gmxapi)`` within Python for
package and module documentation.

..  todo:: Example scripts. See issue `3014 <https://gitlab.com/gromacs/gromacs/-/issues/3014>`_
