Source code for pycif.plugins.datastreams.fluxes.lmdz_netcdf_reg.read

from __future__ import annotations

import datetime

import xarray as xr
from .....utils.check.errclass import CifNotImplementedError




def read(
    self,
    name: str,
    varnames: str,
    dates: list[tuple[datetime.datetime, datetime.datetime]],
    files: list[str],
    tracer: object | None = None,
    **kwargs,
) -> xr.DataArray:
    """Not implemented; always raises.

    Reading LMDZ fluxes on a regular lat-lon NetCDF grid is not yet
    supported.

    Args:
        self: the model Plugin
        name (str): the name of the component
        varnames (str): original name of the variable to read
        dates: list of ``(start, end)`` date intervals to extract
        files (list[str]): list of files matching `dates`
        tracer: the flux tracer plugin

    Raises:
        CifNotImplementedError: Always.
    """
    raise CifNotImplementedError