Standard CIF data vector (standard / std)¶
Description¶
This is the standard pyCIF implementation of the datavect class.
Information about inputs are split into component/parameter categories.
component/parameter categories are fully flexible in terms of names,
but should be consistent with the rest of the configuration.
General component categories include for instance:
- concs:
observed concentrations
- fluxes:
emission fluxes
- inicond:
initial conditions
- meteo:
meteorological fields
For each component, multiple parameters can be defined depending
on diverse species, sectors, etc.
The datavect object is used to define the controlvect
and obsvect objects. Therefore, complementary arguments than those
specific to the datavect can be used in each component/parameter.
Please see details of such additional arguments here
and here.
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¶
dump_debug: (optional): False
Save extra information for debugging purpose. It includes the list of files and dates for each input saved in $workdir/datavect/
accepted type: bool
components: (optional)
List of components in the data vector
- accepted structure:
any_key: (optional)
Name of a given component
- accepted structure:
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
parameters: (optional)
Store the list of parameters for this component
- accepted structure:
any_key: (optional)
Name of a given parameter
- accepted structure:
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
Requirements¶
The current plugin requires the present plugins to run properly:
Requirement name |
Requirement type |
Explicit definition |
Any valid |
Default name |
Default version |
|---|---|---|---|---|---|
domain |
True |
True |
None |
None |
|
model |
True |
True |
None |
None |
|
components |
True |
True |
None |
None |
Yaml template¶
Please find below a template for a Yaml configuration:
1datavect:
2 plugin:
3 name: standard
4 version: std
5 type: datavect
6
7 # Optional arguments
8 dump_debug: XXXXX # bool
9 components:
10 any_key:
11 dir: XXXXX # str
12 file: XXXXX # str
13 varname: XXXXX # str
14 file_freq: XXXXX # str
15 split_freq: XXXXX # str
16 parameters:
17 any_key:
18 dir: XXXXX # str
19 file: XXXXX # str
20 varname: XXXXX # str
21 file_freq: XXXXX # str
22 split_freq: XXXXX # str
