CarbonMonitor / netcdf

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: <class ‘str’>

file: (optional):

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

accepted type: <class ‘str’>

varname: (optional):

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

accepted type: <class ‘str’>

file_freq: (optional): 1M

The time frequency at which data files are available.

accepted type: <class ‘str’>

dir_profiles: (optional): False

Directory where the time and vertical profiles are files should be: TNO_height-distribution_GNFR.csv, timeprofiles-month-in-year_GNFR.csv, timeprofiles-day-in-week_GNFR.csv, timeprofiles-hour-in-day_GNFR.csv

accepted type: <class ‘str’>

cat_select: (optional): [0, 1, 2, 3, 4, 5, 6, 7]

List of Carbon Monitor categories to use (in 0:7 range). By Default all categories are used

accepted values: []

dummy_arg: (optional): let’s say it’s not mandatory

document here the argument

accepted type: <class ‘str’>

lon_min: (optional): -180

Minimum longitude

accepted type: <class ‘float’>

lon_max: (optional): 180

Maximum longitude

accepted type: <class ‘float’>

lat_min: (optional): -90

Minimum latitude

accepted type: <class ‘float’>

lat_max: (optional): 90

Maximum latgitude

accepted type: <class ‘float’>

nlon: (optional): 90

Number of grid cells in the zonal direction

accepted type: <class ‘int’>

nlat: (optional): 45

Number of grid cells in the meridional direction

accepted type: <class ‘int’>

nlev: (optional): 1

Number of levels in the data

accepted type: <class ‘int’>

average_value: (optional): 1

Average value for the generation of random values

accepted type: <class ‘float’>

Yaml template

Please find below a template for a Yaml configuration:

 2  plugin:
 3    name: CarbonMonitor
 4    version: netcdf
 5    type: datastream
 8  # Optional arguments
 9  dir: XXXXX
10  file: XXXXX
11  varname: XXXXX
12  file_freq: XXXXX
13  dir_profiles: XXXXX
14  cat_select: XXXXX
15  dummy_arg: XXXXX
16  lon_min: XXXXX
17  lon_max: XXXXX
18  lat_min: XXXXX
19  lat_max: XXXXX
20  nlon: XXXXX
21  nlat: XXXXX
22  nlev: XXXXX
23  average_value: XXXXX