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


################################
Datastreams (:bash:`datastream`)
################################

.. contents:: Contents
    :local:

Available Datastreams (:bash:`datastream`)
===========================================

The following sub-types and :bash:`datastreams` are implemented in pyCIF so far:

.. toctree::

  meteos/index
  fluxes/index
  backgrounds/index
  fields/index


Description
============

The :bash:`datastream` Plugin type include interfaces to input data for pycif,
with the exception of observations.
It includes the sub-types :bash:`flux`, :bash:`meteo` and :bash:`field`.

It is used for the following purposes:

    i) fetching relevant input files for direct use by, e.g, CTMs, only linking to the
       original file
    ii) reading relevant input files when data manipulation is required, for, e.g.,
        defining the control vector, or auxiliary transformations, such as temporal
        interpolation or horizontal regridding
    iii) writing data from pycif to the corresponding format; this can either be used
         when data from pycif needs to be read as input for a CTM, or for sharing data
         from pycif with a known standard data format


Required parameters, dependencies and functions
===============================================

Functions
+++++++++

A given :bash:`datastream` Plugin requires the following functions to work
properly within pycif:

    - fetch
    - get_domain (optional)
    - read
    - write (optional)

Please find below details on these functions.


.. _datastreams-fetch-funtions:

fetch
---------

The :bash:`fetch` function determines what files and corresponding dates are available
for running the present case.
The structure of the :bash:`fetch` function is shown below:

.. currentmodule:: pycif.plugins.datastreams.fluxes.flux_plugin_template

.. autofunction:: fetch
    :noindex:

|
|
|

.. _datastreams-get_domain-funtions:

get_domain (optional)
----------------------

.. autofunction:: get_domain
    :noindex:

|
|
|

.. _datastreams-read-funtions:

read
------

.. autofunction:: read
    :noindex:

|
|
|

write (optional)
----------------