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: <class ‘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
file: (optional)
File format in the given directory. This value is used if not provided in parameters
file_freq: (optional)
Temporal frequency of files
accepted type: <class ‘str’>
varname: (optional)
Name of the parameter in the files. To be used only if different than the parameter name
accepted type: <class ‘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 parameter.
file: (optional)
File format in the given directory.
file_freq: (optional)
Temporal frequency of files
accepted type: <class ‘str’>
varname: (optional)
Name of the parameter in the files. To be used only if different than the parameter name
accepted type: <class ‘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
8 # Optional arguments
9 dump_debug: XXXXX
10 components: XXXXX