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: (mandatory)
Type of conditions to fetch
accepted values: [‘inicond’, ‘lbc’]
Optional arguments¶
dir: (optional):
Path to the corresponding component. This value is used if not provided in parameters
accepted type: str
file: (optional):
File format in the given directory. This value is used if not provided in parameters
accepted type: str
varname: (optional):
Variable name to use to read data filesinstead of the parameter name if different to the parameter name
accepted type: str
file_freq: (optional): 3H
Temporal frequency at which input files are available. Does not indicate the temporal resolution within each file. Valid only for comp_type=lbc.
accepted type: str
split_freq: (optional)
Force splitting the processing at a given frequency different to file_freq
accepted type: str
Requirements¶
The current plugin requires the present plugins to run properly:
Requirement name |
Requirement type |
Explicit definition |
Any valid |
Default name |
Default version |
|---|---|---|---|---|---|
domain |
False |
False |
ICON-ART |
std |
Yaml template¶
Please find below a template for a Yaml configuration:
1datastream:
2 plugin:
3 name: ICON-ART
4 version: icbc
5 type: datastream
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
