Global Carbon Fluxes (GCP / 1x1)¶
Description¶
This is the plugin to accommodate fluxes as generated for the Global Carbon Project.
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): 1YS
File frequency of GCP files
accepted type: str
split_freq: (optional)
Force splitting the processing at a given frequency different to file_freq
accepted type: str
is_climato: (optional): False
Trueif is a climatologyaccepted type: bool
contact_person: (optional)
Contact person who created the files
accepted type: str
contact_mail: (optional)
Contact mail
accepted type: str
References: (optional)
References (papers, websites) to the original data
accepted type: str
dump_longname: (optional)
Long name of the data
accepted type: str
Yaml template¶
Please find below a template for a Yaml configuration:
1datastream:
2 plugin:
3 name: GCP
4 version: 1x1
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 is_climato: XXXXX # bool
14 contact_person: XXXXX # str
15 contact_mail: XXXXX # str
16 References: XXXXX # str
17 dump_longname: XXXXX # str
