:tocdepth: 4

Welcome to hippynn's documentation!
===================================

We hope you enjoy your stay.

Install hippynn with::

        $ pip install hippynn

(Or see :doc:`the installation documentation <installation/>`)

.. include:: what_is_hippynn.rst

.. toctree::
    :maxdepth: 2
    :caption: Getting Started:

    what_is_hippynn
    How to install hippynn <installation>
    bibliography
    license

.. toctree::
    :maxdepth: 1
    :caption: User Guide:


    user_guide/features
    user_guide/concepts
    user_guide/databases
    user_guide/units
    user_guide/performance
    user_guide/ckernels
    user_guide/loss_graph
    user_guide/settings
    user_guide/custom_nodes
    


.. toctree::
    :maxdepth: 1
    :caption: Examples:


    examples/minimal_workflow
    examples/controller
    examples/plotting
    examples/predictor
    examples/ensembles
    examples/periodic
    examples/forces
    examples/restarting
    examples/ase_calculator
    examples/mliap_unified
    examples/excited_states
    examples/cheq
    examples/weighted_loss
    examples/lightning
    examples/hyperopt


..
    Dev note: the order of this toctree controls whether :mod: and etc links
    in the python domain point at the full documentation, or the summary.

.. toctree::
    :maxdepth: 1
    :caption: API Documentation:

    Full API Documentation <api_documentation/hippynn>
    API Summary Pages <api_summary/hippynn>



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`