Source code for pycif.plugins.datastreams.fields.lmdz_inicond_reg.write

from __future__ import annotations

from os import PathLike
from typing import Any

import xarray as xr




def write(
    self,
    name: str,
    path: str | PathLike,
    data: xr.DataArray,
    metadata: dict[str, Any] | None = None,
    **kwargs,
):
    """Write flux to AEMISSION CHIMERE compatible files.

    Args:
        self (object): this plugin
        name (str): variable name to write
        path (str): path to the target file to write
        data (xarray.DataArray): data
    """
    if not isinstance(data, xr.DataArray):
        plg = self.plugin
        plg_name = f"{plg.name} / {plg.version} / {plg.type}"
        raise TypeError(
            f"Plugin {plg_name} write method 'data' argument should of type "
            f"xarray.DataArray. Passed 'data' argument type: {type(data)}"
        )

    data = data.squeeze("time")

    ds = xr.Dataset(
        {name: (data.dims, data.values)},
        coords=self.domain.get_domain_coords(),
    )

    ds.to_netcdf(path, mode="a")