TM5-4DVAR/rodenbeck TM5-4DVAR/rodenbeck

TM5-4DVAR/rodenbeck TM5-4DVAR/rodenbeck#

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

time_varname : str, optional, default “time1”

Name of the time variable

id_varname : str, optional, default “identification”

Name of the station ID variable

numscale : float, optional, default 1

Scaling factor to apply to the input data

YAML template#

Please find below a template for a YAML configuration:

 1background:
 2  plugin:
 3    name: TM5-4DVAR
 4    version: rodenbeck
 5    type: background
 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
13  time_varname: XXXXX  # str
14  id_varname: XXXXX  # str
15  numscale: XXXXX  # float