EDGARv8/time_profile EDGARv8/time_profile

EDGARv8/time_profile EDGARv8/time_profile#

Description#

Reads EDGARv8 monthly gridded emission NetCDF files and applies country-specific temporal profiles (weekly and hourly, time-zone aware per country using pytz/zoneinfo), selected via an EDGAR global country mask. Developed for the EYECLIMA project.

Grid cells or countries without an available temporal profile fall back to flat (monthly-only) temporal disaggregation.

Warning

In progress: code still needs to be validated and optimized.

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.

dir_profiles : str, optional, default False

Directory where the time profiles are.Files should be in: example /home/satellites14/afortems/CIF-EYECLIMA-CO2/EDGARv8/auxiliary_tables/

profil_select : str, optional, default False

type of temporal profil to use for EDGARv8 . Alternative could be found in read module

global_mask : str, optional, default False

Edgar Global mask of the countries, A3 type names, example: /home/satellites8/amartine/Fluxes/EDGARv8/EDGAR_country_mask.nc

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: EDGARv8
 4    version: time_profile
 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  dir_profiles: XXXXX  # str
14  profil_select: XXXXX  # str
15  global_mask: XXXXX  # str
16  truncated: XXXXX  # bool

See also

API reference (functions & code)