TM5/std TM5/std

TM5/std TM5/std#

Description#

Meteorology plugin for TM5’s directory-based meteo inputs: surface/albedo fields, boundary-layer fields, and cloud/convection fields, stored under an0tr1, h06h18tr1 and h06h18tr3 subdirectories at various native resolutions.

Two generations of fetch/read coexist in this plugin:

  • the original implementation by A. Berchet (fetch_AB/read_AB), which links individual files per date/category and, for read_AB, caches the LMDZ-style physics time step from a defstoke file (this appears to be leftover/inapplicable logic for TM5 meteo);

  • the current implementation (fetch/read) by J.C.A. van Peet, where fetch instead performs a bulk cp -Rsn symlink-copy of the whole meteo directory tree, and read is a non-functional placeholder that always logs a critical error and terminates the process — reading TM5 meteo is not implemented in this code path.

A commented-out input_arguments block (paths for the an0tr1, h06h18tr1 and h06h18tr3 directories) is present but currently disabled.

YAML arguments#

The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:

Optional arguments#

dir : str, optional, default “”

Path to the corresponding component. This value is used if not provided in parameters

file : str, optional, default “”

File format in the given directory. This value is used if not provided in parameters

varname : str, optional, default “”

Variable name to use to read data filesinstead of the parameter name if different to the parameter name

file_freq : str, optional, default “”

Temporal frequency to fetch files

split_freq : str, optional

Force splitting the processing at a given frequency different to file_freq

Requirements#

The current plugin requires the present plugins to run properly:

Requirement name

Requirement type

Explicit definition

Any valid

Default name

Default version

domain

Domain

False

False

dummy

std

YAML template#

Please find below a template for a YAML configuration:

 1meteo:
 2  plugin:
 3    name: TM5
 4    version: std
 5    type: meteo
 6
 7  # Optional arguments
 8  dir: XXXXX  # str
 9  file: XXXXX  # str
10  varname: XXXXX  # str
11  file_freq: XXXXX  # str
12  split_freq: XXXXX  # str

See also

API reference (functions & code)