pycif.plugins.datastreams.fields.lmdz_chemfield_reg — API reference

pycif.plugins.datastreams.fields.lmdz_chemfield_reg — API reference#

Configuration reference: lmdz_chemfield_reg plugin

pycif.plugins.datastreams.fields.lmdz_chemfield_reg.fetch.fetch(ref_dir: str | PathLike, ref_file: str | PathLike, input_interval: tuple[datetime, datetime], target_dir: str | PathLike, tracer: object | None = None, **kwargs) → tuple[dict[datetime, list[str | PathLike]], dict[datetime, list[tuple[datetime, datetime]]]][source]#
pycif.plugins.datastreams.fields.lmdz_chemfield_reg.read.read(self, name: str, varnames: str, dates: list[tuple[datetime, datetime]], files: list[str | PathLike], ddi: datetime | None = None, **kwargs)[source]#

Get fluxes from pre-computed fluxes and load them into a pyCIF variables

Parameters:

  • self – the fluxes Plugin

  • name – the name of the component

  • tracdir – flux directory and file format

  • tracfile – flux directory and file format

  • dates – list of dates to extract

  • interpol_flx (bool) – if True, interpolates fluxes at time t from

  • files (values of surrounding available)

pycif.plugins.datastreams.fields.lmdz_chemfield_reg.write.write(self, name: str, path: str | PathLike, data: DataArray, **kwargs) → None[source]#

Write prescribed species files for LMDZ

Parameters:

  • self – this plugin

  • path (str) – path to the file to write

  • data (xarray.Dataset or xarray.DataArray) – Data to write