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

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

Configuration reference: chimere plugin

pycif.plugins.datastreams.fluxes.chimere.fetch.fetch(ref_dir, ref_file, input_interval, target_dir, tracer=None, **kwargs)[source]#
pycif.plugins.datastreams.fluxes.chimere.read.read(self, name, varnames, dates, files, interpol_flx=False, tracer=None, model=None, ddi=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.fluxes.chimere.write.write(self, name, flx_file, flx, mode='a', metadata=None, **kwargs)[source]#

Write flux to AEMISSION CHIMERE compatible files.

Parameters:

  • self (Fluxes) – the Fluxes plugin

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

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

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

pycif.plugins.datastreams.fluxes.chimere.write.write_AEMISSIONS(name, flx_file, flx, mode='a', lon=None, lat=None, nlev=1, ncformat='NETCDF4')[source]#

Auxiliary function that can be used outside pycif