#############
Installation
#############

.. role:: bash(code)
   :language: bash

All the source files are distributed with pyCIF in the directory :bash:`model_sources/chimereGES/`.

============
Requirements
============

CHIMERE is coded in Fortran90 and can be compiled either with ifort or gfortran.

In both case, the following libraries should be compiled before hand with the corresponding compiler:

    - MPI
    - NetCDF

===========================
Testing with a docker image
===========================

CHIMERE is automatically tested in a docker image built based on the Dockerfile :bash:`pycif-ubuntu.Dockerfile`
provided with pyCIF sources.
To build it locally, use the following command (assuming that Docker is properly installed on your system):

.. code-block:: bash

    cd CIF_ROOT_DIR
    docker build -f pycif-ubuntu.Dockerfile -t localimage ./

It can also be directly downloaded from DockerHub using

.. code-block:: bash

    docker pull pycif/pycif-ubuntu:0.1

From there, you can use examples :doc:`here </yaml_examples/chimere/index>` to compile and use CHIMERE.
The model can be compiled manually using instructions :doc:`here <compiling>`

See further instructions on how to use pyCIF inside a Docker image :doc:`here</docker/index>`.

=================
CHIMERE test data
=================

Test data with simple configurations cases (very small domains easy to compute on a desktop)
are available `here <https://sharebox.lsce.ipsl.fr/index.php/s/zUpoUXODKFLZJrf/download>`__.