tutorial.rst

Tutorial
========

So, you are planning to use the Earth Diagnostics? You don't know how to use them? This is the place to go.
From now on this tutorial will guide you through all the process from installation to running.

.. Hint::
    If you have any problem with this tutorial, please report it to <javier.vegas@bsc.es> so it can be corrected.
    A lof of people will benefit from it and you will be mentioned here.

Installation
------------

For now, you only have an option: dowload the diagnostics directly from BSC-ES's Gitlab:

.. code-block:: sh

    git clone https://earth.bsc.es/gitlab/es/ocean_diagnostics.git

You will also need

* CDO version 1.6.9 (other versions could work, but this is the one we use)
* NCO version 4.5.4 or newer
* Python 2.7 or newer (but no 3.x) with Autosubmit, CDO and NCO packages
* Acces to CDFTOOLS_3.0 executables for BSC-ES. At this point, those are located at /home/Earth/jvegas/CDFTOOLS_CMOR/bin.

Call the diags with -h option to see if everything is ready:

.. code-block:: sh

    ${PATH_TO_REPOSITORY}/earthdiagnostics.diags.py -h

Creating a config file
----------------------

If you go into the earthdiagnostics folder in the git repository, you will see a diags.conf that can be used as a model
for your config file. It contains commentaries explaining what represents each one of its parameters, so please read it
carefully.

Once you have configured your experiment you can execute any diagnostic by calling this command (substitute the
variables for the real paths before launching, please)

.. code-block:: sh

    ${PATH_TO_REPOSITORY}/earthdiagnostics.diags.py ${PATH_TO_MY_CONF_FILE}

And... that's it. You will find your results inside CMOR's folder tree and a folder for the temp files in the scratch.
This folder is named after the EXPID.