wrfchem/icbc wrfchem/icbc

wrfchem/icbc wrfchem/icbc#

Description#

Read and write WRF-Chem wrfinput/wrfbdy initial and lateral boundary condition NetCDF files.

Adapted from chimere_icbc; comp_type selects between initial condition (inicond, a single wrfinput-style file) and lateral condition (latcond, a single wrfbdy file) handling in fetch, read and write. Lateral conditions follow WRF’s tendency-based boundary layout: perimeter values are stored per side (_BXS/_BXE/_BYS/_BYE) together with trend variables (_BTxx) used to extrapolate one extra time step beyond the last one present in the file.

Note

Reading initial conditions (comp_type="inicond") is not implemented yet.

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

forced_varname : str, optional

Variable name to use in initial condition files if different from what CIF call it with

comp_type : “inicond” or “latcond”, optional, default “”

Type of conditions

  • “inicond”: inicond

  • “latcond”: latcond

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

wrfchem

std

chemistry

Chemistry

True

True

None

None

YAML template#

Please find below a template for a YAML configuration:

 1field:
 2  plugin:
 3    name: wrfchem
 4    version: icbc
 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
13  forced_varname: XXXXX  # str
14  comp_type: XXXXX  # inicond|latcond

See also

API reference (functions & code)