dubfi.fluxes.dataprovider
=========================

.. py:module:: dubfi.fluxes.dataprovider

.. autoapi-nested-parse::

   Abstract data provider interface.

   .. codeauthor:: Valentin Bruch, DWD <valentin.bruch@dwd.de>
   .. versionadded:: 0.1.1



Classes
-------

.. autoapisummary::

   dubfi.fluxes.dataprovider.AbstractDataProvider
   dubfi.fluxes.dataprovider.InsituDataProvider


Module Contents
---------------

.. py:class:: AbstractDataProvider

   Bases: :py:obj:`abc.ABC`


   Abstract base class for data providers for inversion.


   .. py:property:: config
      :type: dict[str, Any]

      :abstractmethod:


      Inversion configuration.


   .. py:property:: coords
      :type: dict[str, Any]

      :abstractmethod:


      Data coordinates, see :func:`dubfi.fluxes.readobs.coordinates_from_config`.


   .. py:method:: get_R()
      :abstractmethod:


      Get R parametrized operator (error covariance matrix).

      For the ensemble flux inversion, this operator is constructed
      as described in :doc:`/scidoc/rmatrix`.



   .. py:method:: get_H()
      :abstractmethod:


      Get H parametrized vector (observation operator).

      For the flux inversion, this is just a linear operator (i.e.,
      a matrix). A possible offset or background concentration in
      the model prediction should be directly subtracted from the
      vector returned by :meth:`get_Y`.



   .. py:method:: get_Y()
      :abstractmethod:


      Get Y vector (observation minus model prior).

      This is usually the vector of observations minus the model
      prior, or the observations minus the model background.



.. py:class:: InsituDataProvider

   Bases: :py:obj:`AbstractDataProvider`


   Abstract base class for data providers for inversion.


   .. py:method:: weight_outliers()

      Inflate uncertainty for outliers.

      :raises RuntimeError: if called a second time



   .. py:method:: apply_global_inflation()

      Apply global uncertainty inflation in-place.

      :raises RuntimeError: if called a second time



   .. py:method:: read_data()
      :abstractmethod:


      Read data from files.



   .. py:method:: _read_ens(fname, times, obsidcs, **netcdf_kw)

      Read ensemble data, helper for :meth:`~read_data`.



   .. py:method:: _read_det(fname, times, obsidcs, ssh, same_site_count, **netcdf_kw)

      Read deterministic data, helper for :meth:`~read_data`.