Global Carbon Fluxes GCP/1x1

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 : str, optional, default “”

Path to the corresponding component. This value is used if not provided in parameters

file : str, optional, default “”

File format in the given directory. This value is used if not provided in parameters

varname : str, optional, default “”

Variable name to use to read data filesinstead of the parameter name if different to the parameter name

file_freq : str, optional, default “1YS”

File frequency of GCP files

split_freq : str, optional

Force splitting the processing at a given frequency different to file_freq

is_climato : bool, optional, default False

True if is a climatology

contact_person : str, optional

Contact person who created the files

contact_mail : str, optional

Contact mail

References : str, optional

References (papers, websites) to the original data

dump_longname : str, optional

Long name of the data

YAML template#

Please find below a template for a YAML configuration:

 1flux:
 2  plugin:
 3    name: GCP
 4    version: 1x1
 5    type: flux
 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