5. Run
######

The r&d experiments have to be ran in `hindcast` mode.
Follow the receipe below in order to run a workflow.

.. glossary::

    1. Define a workflow
        A workflow is a series of tasks that will be submitted by sloop.
        Several tasks can be executed in parallel.
        Herebelow is an example of a configuration file named 
        `mangahindcast.cfg`.

        .. literalinclude:: examples/mangahindcast.cfg
            :language: ini
            
    2. Submit the workflow
            The :doc:`cli.sloop.run` command can submit a workflow.
             
            By executing the following command, sloop will submit the workflow 
            defined in the configuration file named `mangahindcast.cfg`::
        
                $ sloop run -w mangahindcast --ncycle 2 --freq 7
            
            .. note::
            
                ``ncycle`` give the number of model run. 
                ``freq`` give the duration of one model run.
            
.. warning::
    
    ``sloop run`` has to be executed in the directory of the experiment
    created by ``sloop init``.

Hindcast tasks
==============

.. list-table::

    * - recextfiles_hindcast
      - fetch input data stored on an archive remote server (hendrix for instance)
    * - run_ic_hindcast
      - build an initial condition from psy4 model output
    * - run_bc_hindcast
      - build the boundary conditions from psy4 model output
    * - run_atmfrc_hindcast
      - build atmospheric forcing
    * - run_rivers_hindcast
      - build rivers forcing
    * - run_model_hindcast_spnudge
      - model run in spectral nudging mode
    * - run_model_hindcast_free
      - free model run
    * - run_postprod_soap_hindcast_spnudge
      - spectral nudging model output formatting for soap
    * - run_postprod_soap_hindcast_free
      - free model output formatting for soap