Welcome to ATMOS Analogue Digital Twin (ADAM)'s documentation!
==============================================================

.. grid:: 1 2 2 2
    :gutter: 2

    .. grid-item-card:: :octicon:`book;10em`
        :link: user_guide/index
        :link-type: doc
        :text-align: center

        **User Guide**

        The cookbook provides in-depth information on how
        to use ADAM, including how to get started.
        This is where to look for general conceptual descriptions on how
        to use parts of ADAM, including how to make your first lake breeze front and
        the required data preprocessing to do so.

    .. grid-item-card:: :octicon:`list-unordered;10em`
        :link: dev_reference/index
        :link-type: doc
        :text-align: center

        **Reference Guide**

        The reference guide contains detailed descriptions on
        every function and class within ADAM. This is where to turn to understand
        how to use a particular feature or where to search for a specific tool

    .. grid-item-card:: :octicon:`terminal;10em`
        :link: contributors_guide/index
        :link-type: doc
        :text-align: center

        **Developer Guide**

        Want to help make ADAM better? Found something
        that's not working quite right? You can find instructions on how to
        contribute to ADAM here. You can also find detailed descriptions on
        tools useful for developing ADAM.

    .. grid-item-card:: :octicon:`graph;10em`
        :link: auto_examples/index
        :link-type: doc
        :text-align: center

        **Example Gallery**

        Check out ADAM's gallery of examples which contains
        sample code demonstrating various parts of ADAM's functionality.

Getting started
===============

ADAM is published on PyPI as ``adam-atmos``:

.. code-block:: console

    $ pip install adam-atmos

See :doc:`installation` for installing from source and for the full list of
requirements.

.. toctree::
   :hidden:
   :maxdepth: 2

   installation
   user_guide/index
   auto_examples/index
   dev_reference/index
   contributors_guide/index

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: About

   readme
   history
   authors

Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`