pycif.plugins.datastreams.fluxes.lmdz_sflx — API reference

pycif.plugins.datastreams.fluxes.lmdz_sflx — API reference#

Configuration reference: lmdz_sflx plugin

pycif.plugins.datastreams.fluxes.lmdz_sflx.fetch.fetch(ref_dir, ref_file, date_interval, target_dir, tracer=None, **kwargs)[source]#
pycif.plugins.datastreams.fluxes.lmdz_sflx.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 model 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.fluxes.lmdz_sflx.write.write(self, name, flx_file, flx, mode='a', metadata=None, **kwargs)[source]#

Write flux to LMDZ-DISPERSION compatible files. The shape follows the LMDZ physical vectorial shape grid.

Parameters:

  • self (Fluxes) – the Fluxes plugin

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

  • flx (xarray.Dataset) – fluxes data to write