ICON-ART initial and lateral boundary conditions ICON-ART/icbc

ICON-ART initial and lateral boundary conditions ICON-ART/icbc#

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:

Mandatory arguments#

comp_type : “inicond” or “lbc”, mandatory

Type of conditions to fetch

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 “3H”

Temporal frequency at which input files are available. Does not indicate the temporal resolution within each file. Valid only for comp_type=lbc.

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

ICON-ART

std

YAML template#

Please find below a template for a YAML configuration:

 1field:
 2  plugin:
 3    name: ICON-ART
 4    version: icbc
 5    type: field
 6
 7    # Mandatory arguments
 8    comp_type: XXXXX  # inicond|lbc
 9
10    # Optional arguments
11    dir: XXXXX  # str
12    file: XXXXX  # str
13    varname: XXXXX  # str
14    file_freq: XXXXX  # str
15    split_freq: XXXXX  # str