.. adept documentation master file, created by
   sphinx-quickstart on Wed Nov  8 15:35:24 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

ADEPT
=========

.. image:: adept-logo.png
   :alt: ADEPT
   :align: right

**ADEPT** is a set of **A** utomatic **D** ifferentation **E** nabled **P** lasma **T** ransport solvers.


Examples
----------
Examples can be found in the tests folder or in the adept-notebooks repository - http://github.com/ergodicio/adept-notebooks. Example configuration files are also provided in `configs/`

--------------------------------------------------

Documentation
------------------

.. toctree::
   usage
   solvers
   faq
   api
   :maxdepth: 2
   :caption: Contents:

.. note::

   This project is under active development.


Contributing guide
------------------------
The contributing guide is in development but for now, just make an issue / pull request and we can go from there :)

Citation
------------
[1] A. S. Joglekar and A. G. R. Thomas, “Machine learning of hidden variables in multiscale fluid simulation,” Mach. Learn.: Sci. Technol., vol. 4, no. 3, p. 035049, Sep. 2023, doi: 10.1088/2632-2153/acf81a.


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

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