GridFED emission database GridFED/std

GridFED emission database GridFED/std#

Description#

This is the plugin to accommodate fluxes as generated by GridFED database. Yearly files with monthly resolution can be downloaded on Zenodo: here.

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 GridFED outputs

split_freq : str, optional

Re-bucket this tracer’s fetched dates/files onto a fixed pandas-frequency grid (e.g. '1D', '1MS', '1YS'), independently of the native frequency the files were found at (file_freq). This fixes the sub-simulation boundaries that fromcontrol inherits for this tracer. For minimal memory usage, match it to the consuming model’s own periodicity: a finer value costs an extra time_interpolation bridge for no memory benefit, while a coarser value keeps the tracer’s data resident in memory across every one of the model’s sub-simulations it spans. See the ‘Splitting the temporal grid’ section on the observation operator page for the full mechanism and worked examples.

group_name : str, optional, default “CO2”

Group (indicating the species) to use in the files

sectors : list, optional, default [‘OIL’, ‘GAS’, ‘COAL’, ‘CEMENT’, ‘BUNKER’]

List of sectors to add to produce outputs

YAML template#

Please find below a template for a YAML configuration:

 1flux:
 2  plugin:
 3    name: GridFED
 4    version: std
 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  group_name: XXXXX  # str
14  sectors: XXXXX  # list

See also

API reference (functions & code)