CHIMERE/std CHIMERE/std

CHIMERE/std CHIMERE/std#

Description#

Reads and writes CHIMERE-format METEO.nc meteorological files.

These are NetCDF files with a Times character-string variable and Time/bottom_top/south_north/west_east dimensions, split into one file per period (tracer.file_freq). fetch locates and links the files covering a requested interval; read extracts requested variables at the correct hourly index; and write dumps pyCIF meteo/flux data back out to a CHIMERE-compatible NetCDF file, renaming dimensions to CHIMERE conventions, adding lon/lat and sigma vertical coordinates, and optionally compressing float32 output when ncformat is NETCDF4.

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 “METEO.%Y%m%d%H.{nho}.nc”

form of the name of the files to use if different from METEO.YYYYMMDDHH.hh.nc

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.

ncformat : “NETCDF4” or “NETCDF3_CLASSIC”, optional, default “NETCDF4”

NETCDF4 or NETCDF3_CLASSIC

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

CHIMERE

std

YAML template#

Please find below a template for a YAML configuration:

 1meteo:
 2  plugin:
 3    name: CHIMERE
 4    version: std
 5    type: meteo
 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  ncformat: XXXXX  # NETCDF4|NETCDF3_CLASSIC

See also

API reference (functions & code)