TM5/std TM5/std

TM5/std TM5/std#

Description#

Reads/writes TM5 emission NetCDF-4 files.

Fluxes are organized as nested NetCDF-4 groups per region (glb600x400/glb300x200), species, and source category (biomass-burning, rice, wetlands, other); read sums all source categories for the active region. An additional read_adj function (not part of the plugin’s read/write interface) reads TM5 adjoint emission-factor files (adj_emissions.nc4).

Note

Two historical implementations coexist in read.py/write.py: an original version by A. Berchet (read_AB/write_AB, kept for reference, not wired into the plugin) and a rewritten, more defensive version by J.C.A. van Peet (read/write), which is the one actually used by the 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

Force splitting the processing at a given frequency different to file_freq

exp_conversion : optional, default False

Apply the exponential conversion if fluxes stored as non-linear variable

Requirements#

The current plugin requires the present plugins to run properly:

Requirement name

Requirement type

Explicit definition

Any valid

Default name

Default version

domain

Domain

False

False

dummy

std

YAML template#

Please find below a template for a YAML configuration:

 1flux:
 2  plugin:
 3    name: TM5
 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  exp_conversion: XXXXX  # any

See also

API reference (functions & code)