ICON-ART surface fluxes (ICON-ART
/ sflx
)¶
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: (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):
Temporal frequency to fetch files
accepted type: str
split_freq: (optional)
Force splitting the processing at a given frequency different to file_freq
accepted type: str
tfactors_hod_file: (optional)
Hour-of-day temporal scaling factors.
tfactors_dow_file: (optional)
Day-of-week temporal scaling factors.
tfactors_moy_file: (optional)
Month-of-year temporal scaling factors.
tfactors_hoy_file: (optional)
Hour-of-year temporal scaling factors.
oem_group: (optional)
Name of the OEM group to fetch.
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: sflx
5 type: datastream
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 tfactors_hod_file: XXXXX # any
14 tfactors_dow_file: XXXXX # any
15 tfactors_moy_file: XXXXX # any
16 tfactors_hoy_file: XXXXX # any
17 oem_group: XXXXX # any