.. Community Inversion Framework documentation master file, created by
   sphinx-quickstart on Thu Mar 14 13:43:55 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the Community Inversion Framework!
=========================================================

.. note::
    *This is the official website of the Community Inversion Framework (CIF).
    *The development of CIF was initially supported by the European Union H2020 project* VERIFY_.
    *CIF is now supported by the projects* `CoCO2 <https://coco2-project.eu/>`__ and `EYE-CLIMA <http://eyeclima.eu/>`__.

.. warning::
    The Community Inversion Framework is governed by the CeCILL-C license under French law.
    Please consult the reference text `here <https://cecill.info/licences/Licence_CeCILL-C_V1-en.html>`__ for further detail.
    The license grants full rights for the users to use, modify and redistribute the original version of the CIF,
    conditional to the obligation to make their modifications available to the community
    and to properly acknowledge the original authors of the code.


.. admonition:: Use, aknowledgement and citation

    The Community Inversion Framework has been designed by a community of scientists who agreed to openly share their developments.
    The maintenance and further developments are made possible through continued efforts by the core team of developer,
    with the support of their respective funding agencies.

    Any use of the Community Inversion Framework should then be fairly acknowledged.
    Users are required to establish contact with `the team of developers <help@community-inversion.eu>`__ to determine an appropriate level of acknowledgement
    through co-authorship and relevant citations.

.. _VERIFY: http://verify.lsce.ipsl.fr

.. toctree::
    :maxdepth: 2
    :caption: Table of contents:

    overview/index
    publications/index
    contributing
    installation
    docker/index
    projects/index
    documentation/index
    usertutos/users-tutorials
    devtutos/developers-tutorials
    yaml_examples/index


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

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

Help Desk
=========

We do our best to make this website as comprehensive as possible.

However, should you find no answer to your questions, please contact: `help@community-inversion.eu <help@community-inversion.eu>`__

It is also possible to register to the information mailing list dedicated to CIF: `info-cif@lists.lsce.ipsl.fr <info-cif@lists.lsce.ipsl.fr>`__.
Important information, as well as general discussions, are posted on that list.
Only subscribers can post and receive corresponding mails.
To subscribe, one can send an empty mail to `sympa@lists.lsce.ipsl.fr <sympa@lists.lsce.ipsl.fr>`__ with the following
command as object: ``SUBSCRIBE info-cif@lists.lsce.ipsl