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

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

Configuration reference: lmdz_prodloss3d plugin

pycif.plugins.datastreams.fields.lmdz_prodloss3d.fetch.fetch(ref_dir, ref_file, input_interval, target_dir, tracer=None, **kwargs)[source]#
pycif.plugins.datastreams.fields.lmdz_prodloss3d.read.read(self, name, tracdir, tracfile, varnames, dates, interpol_flx=False, comp_type=None, model=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_prodloss3d.write.write(self, prescr_file, prodloss, mode='a', **kwargs)[source]#

Write prescribed species files for LMDZ

Parameters:

  • self (Fluxes) – the Fluxes plugin

  • prescr_file (str) – the file where to write fluxes

  • prodloss (xarray.DataArray) – prescribed species data to write

  • mode (str) – ‘w’ to overwrite, ‘a’ to append