FLEXPART/nc FLEXPART/nc

FLEXPART/nc FLEXPART/nc#

Description#

Reads gridded surface flux NetCDF files (typically CH4) used to force or compare against FLEXPART Lagrangian transport simulations.

Supports cropping the input flux field to a regional nested domain (crop_region), with an optional “global” background flux file (file_glob) filling in the area outside the nest. Fluxes are converted from their native units to ng/m2/s if convert_to_flux is set.

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

File frequency

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.

latname_flx : str, optional, default “latitude”

Name of the latitude variable

lonname_flx : str, optional, default “longitude”

Name of the longitude variable

timename_flx : str, optional, default “time”

Name of the time variable

crop_region : bool, optional, default True

Crop input to the regional extend

convert_to_flux : bool, optional, default True

Convert to ng/m2/s

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

FLEXPART

std

YAML template#

Please find below a template for a YAML configuration:

 1flux:
 2  plugin:
 3    name: FLEXPART
 4    version: nc
 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  latname_flx: XXXXX  # str
14  lonname_flx: XXXXX  # str
15  timename_flx: XXXXX  # str
16  crop_region: XXXXX  # bool
17  convert_to_flux: XXXXX  # bool

See also

API reference (functions & code)