EDGAR/v5 EDGAR/v5

EDGAR/v5 EDGAR/v5#

Description#

Yearly gridded NetCDF emission files from the EDGAR v5 (Emissions Database for Global Atmospheric Research) inventory.

The domain can either be truncated (regional, using the native grid of the input file) or a fixed global 0.1°x0.1° grid, depending on truncated. If the file for the requested year is missing and closest_year is set, the closest available year (at or before the requested one) is used instead.

Units: umol/m2/s.

Writing is not implemented for this plugin.

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 “”

Temporal frequency to fetch files

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.

closest_year : bool, optional, default False

If the correct year is not available, use the closest one

truncated : bool, optional, default False

If the domain is not global

YAML template#

Please find below a template for a YAML configuration:

 1flux:
 2  plugin:
 3    name: EDGAR
 4    version: v5
 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  closest_year: XXXXX  # bool
14  truncated: XXXXX  # bool

See also

API reference (functions & code)