.. Easy Gems documentation master file, created by
   sphinx-quickstart on Tue Jun  8 15:09:22 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to easy.gems!
=====================================

.. image:: _static/images/landing-page-banner.png
   :width: 80%
   :align: center
   :class: transparent
   :alt: Three different globes with increasing level of detail.
         The refinement of the globes illustrates the development of
         Earth system models in the recent years.


`DKRZ <https://dkrz.de/en>`_ has created easy.gems as a user-driven site for documenting high-resolution climate simulation output and its increasingly challenging analysis. While it started within the frame of the DYAMOND intercomparison initiative, it is aimed at going beyond individual projects and at documenting all "simulation gems" hosted at DKRZ.

The book comprises three main chapters, one providing information on the currently included :doc:`Simulations <simulations/index>`, another one providing hints and example scripts for :doc:`Processing <Processing/index>` the data, and a last one explaining ways to :doc:`Contribute <intro/getting-started>` and join this community effort.

.. grid:: 3

    .. grid-item-card::  Simulations

         .. image:: _static/images/earth-africa-solid.svg
            :width: 100
            :align: center
            :target: simulations/index.html
            :class: transparent

    .. grid-item-card::  Processing

         .. image:: _static/images/gears-solid.svg
            :width: 100
            :align: center
            :target: Processing/index.html
            :class: transparent

    .. grid-item-card:: Contribute

         .. image:: _static/images/users-solid.svg
            :width: 100
            :align: center
            :target: intro/getting-started.html
            :class: transparent


.. admonition:: Joint nextGEMS--EERIE--hackathon

   See :ref:`nextGEMS_EERIE_hackathon` for more info.


.. admonition:: easy.gems needs your expertise!

   Please consider opening an `issue <https://gitlab.dkrz.de/easy/gems/-/issues/new>`_ for missing or unclear statements or :doc:`add <intro/getting-started>` your tips, scripts and other information.

.. toctree::
   :hidden:
   :maxdepth: 1
   :glob:

   Simulations <simulations/index>
   Processing <Processing/index>
   Contribute <intro/getting-started>

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

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