----------------------------------------------
Setting the mapper with input fluxes
----------------------------------------------

.. currentmodule:: pycif.plugins.models.template

Here, we propose to prepare fluxes for the model.
This is possible in the template by using the option ``include_fluxes`` in the model
paragraph.

.. literalinclude:: ../yml/6-1_inputerror.yml
    :linenos:
    :language: yaml

Try running the yaml as is. It will return an error because inputs (fluxes
in our case) are not defined in the Yaml, more specifically in the
``datavect`` paragraph.
One can examine debugging text files in ``$workdir`/obsoperator/`` to get further
information about expected inputs.

At this step, one has to include a flux plugin to fetch flux files for one's model
if not already available.
Please consult the dedicated tutorial :doc:`here </documentation/devtutos/newfluxdata/index>`
to implement a new flux Plugin.

Therein, one should define a ``get_domain`` function to define the flux domain,
as well as a ``list_dates`` in the function ``fetch``.
Make sure that the domain and dates in the flux plugin are consistent with the ones
in the model ``mapper``.
If everything is consistent, pyCIF will not read the data and one should just link
original files in ``native2inputs``

Below is an example with fluxes generated using a basic formula.
One can use it to check what steps are computed and what is provided to the
function ``native2inputs``:


.. literalinclude:: ../yml/6-2_includefluxes.yml
    :linenos:
    :language: yaml