LMDz trajq files LMDZ-trajq/netcdf

LMDz trajq files LMDZ-trajq/netcdf#

Description#

Reads LMDz trajq_*.nc output/trajectory files: model concentration output along the forward trajectory, on the model’s cyclic regular grid.

The domain is built directly from the trajq files themselves (including hybrid ap/bp vertical coefficients read from a separate vertical coordinate file), rather than from a dedicated domain file. Values are in ppb dry air.

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 “trajq_%Y%m%d%H%M.nc”

file format for the trajq files

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.

YAML template#

Please find below a template for a YAML configuration:

 1field:
 2  plugin:
 3    name: LMDZ-trajq
 4    version: netcdf
 5    type: field
 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

See also

API reference (functions & code)