LMDz production and loss fields LMDZ/prodloss3d#
Description#
This plugin reads and writes 3D chemical production and loss fields for LMDZ.
Production/loss fields are read from monthly NetCDF files, one file per
month with a daily time index, similarly to lmdz_chemfield: the
requested variable is expected to be named <species>_prod in the
file.
Writing produces a Fortran binary file with the forward and
tangent-linear (fwd/tl) prescribed-species production/loss
arrays, used internally by the tangent-linear/adjoint model rather than
as a NetCDF product.
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
Requirements#
The current plugin requires the present plugins to run properly:
Requirement name |
Requirement type |
Explicit definition |
Any valid |
Default name |
Default version |
|---|---|---|---|---|---|
domain |
False |
False |
LMDZ |
std |
YAML template#
Please find below a template for a YAML configuration:
1field:
2 plugin:
3 name: LMDZ
4 version: prodloss3d
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