pycif.plugins.datastreams.meteos.tm5_meteo — API reference

pycif.plugins.datastreams.meteos.tm5_meteo — API reference#

Configuration reference: tm5_meteo plugin

pycif.plugins.datastreams.meteos.tm5_meteo.fetch.fetch_AB(ref_dir, ref_file, input_interval, target_dir, tracer=None, component=None, **kwargs)[source]#

Reads meteorology and links to the working directory

Parameters:
  • meteo (dictionary) – dictionary defining the domain. Should include

  • meteorology (dirmeteo to be able to read the)

  • datei (datetime.datetime) – initial date for the inversion window

  • datef (datetime.datetime) – end date for the inversion window

  • workdir (str) – path to the working directory where meteo files should be copied

  • logfile (str) – path to the log file

  • filetypes ([str]) – list of file radicals to copy in the working directory

  • **kwargs (dictionary) – extra arguments

Returns:

Notes: At some point, include option to compute mass fluxes for LMDz, with different physics What is needed to do that? Possible only on CCRT? Flexibility to define new domains Can be very heavy and not necessarily relevant

pycif.plugins.datastreams.meteos.tm5_meteo.fetch.fetch(ref_dir, ref_file, input_interval, target_dir, tracer=None, component=None, **kwargs)[source]#

PURPOSE Link to meteo directory from datavect/meteo. Use “cp -as …” to create symbolic links: the directory names are copied, but files in the directories are linked.

VERSION HISTORY 2.0 17-05-2021 by J.C.A. van Peet

Changed function, it now copies the full meteo directory as links.

1.0 28-04-2021 by A. Berchet

Original code (see above)

pycif.plugins.datastreams.meteos.tm5_meteo.read.read_AB(self, name, tracdir, tracfile, varnames, dates, interpol_flx=False, tracer=None, model=None, filetypes=['defstoke', 'fluxstoke', 'fluxstokev', 'phystoke'], **kwargs)[source]#

Reads meteorology and links to the working directory

Parameters:
  • meteo (dictionary) – dictionary defining the domain. Should include

  • meteorology (dirmeteo to be able to read the)

  • datei (datetime.datetime) – initial date for the inversion window

  • datef (datetime.datetime) – end date for the inversion window

  • workdir (str) – path to the working directory where meteo files should be copied

  • logfile (str) – path to the log file

  • filetypes ([str]) – list of file radicals to copy in the working directory

  • **kwargs (dictionary) – extra arguments

Returns:

Notes: At some point, include option to compute mass fluxes for LMDz, with different physics What is needed to do that? Possible only on CCRT? Flexibility to define new domains Can be very heavy and not necessarily relevant

pycif.plugins.datastreams.meteos.tm5_meteo.read.read(self, name, tracdir, tracfile, varnames, dates, interpol_flx=False, tracer=None, model=None, filetypes=['defstoke', 'fluxstoke', 'fluxstokev', 'phystoke'], **kwargs)[source]#

PURPOSE No idea…

VERSION HISTORY 2.0 17-05-2021 by J.C.A. van Peet

Made this placeholder function that just issues an error message…

1.0 28-04-2021 by A. Berchet

Original code (see above)