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

main_flx_arg: (optional): totototo

document here the argument

accepted type: <class ‘str’>

file_freq: (optional): 1YS

File frequency of GCP files

accepted type: <class ‘str’>

is_climato: (optional): False

True if is a climatology

accepted type: <class ‘bool’>

contact_person: (optional)

Contact person who created the files

accepted type: <class ‘str’>

contact_mail: (optional)

Contact mail

accepted type: <class ‘str’>

References: (optional)

References (papers, websites) to the original data

accepted type: <class ‘str’>

dump_longname: (optional)

Long name of the data

accepted type: <class ‘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
 8  # Optional arguments
 9  main_flx_arg: XXXXX
10  file_freq: XXXXX
11  is_climato: XXXXX
12  contact_person: XXXXX
13  contact_mail: XXXXX
14  References: XXXXX
15  dump_longname: XXXXX