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: 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): 1M
The time frequency at which data files are available.
accepted type: str
split_freq: (optional)
Force splitting the processing at a given frequency different to file_freq
accepted type: 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: 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: str
lon_min: (optional): -180
Minimum longitude
accepted type: float
lon_max: (optional): 180
Maximum longitude
accepted type: float
lat_min: (optional): -90
Minimum latitude
accepted type: float
lat_max: (optional): 90
Maximum latgitude
accepted type: float
nlon: (optional): 90
Number of grid cells in the zonal direction
accepted type: int
nlat: (optional): 45
Number of grid cells in the meridional direction
accepted type: int
nlev: (optional): 1
Number of levels in the data
accepted type: int
average_value: (optional): 1
Average value for the generation of random values
accepted type: float
Yaml template¶
Please find below a template for a Yaml configuration:
1datastream:
2 plugin:
3 name: CarbonMonitor
4 version: netcdf
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 dir_profiles: XXXXX # str
14 cat_select: XXXXX #
15 dummy_arg: XXXXX # str
16 lon_min: XXXXX # float
17 lon_max: XXXXX # float
18 lat_min: XXXXX # float
19 lat_max: XXXXX # float
20 nlon: XXXXX # int
21 nlat: XXXXX # int
22 nlev: XXXXX # int
23 average_value: XXXXX # float
