pycif.plugins.datastreams.backgrounds.tm5_background — API reference

pycif.plugins.datastreams.backgrounds.tm5_background — API reference#

Configuration reference: tm5_background plugin

pycif.plugins.datastreams.backgrounds.tm5_background.fetch.fetch(ref_dir, ref_file, date_interval, target_dir, tracer=None, **kwargs)[source]#
pycif.plugins.datastreams.backgrounds.tm5_background.read.read(self, name, varnames, dates, files, interpol_flx=False, tracer=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.backgrounds.tm5_background.write.write(self, prescr_file, prescr, typefile, 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

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

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