LMDZ regular lat-lon domain LMDZ/regular

LMDZ regular lat-lon domain LMDZ/regular#

Description#

LMDZ regular lat-lon domain plugin.

Reads the horizontal and vertical grid used by the LMDZ structured (regular lat-lon) model from a NetCDF file.

file (under optional dir) must contain the horizontal grid coordinates. If the vertical levels are stored in a separate file, file_vcoord (and optionally dir_vcoord) may be provided.

The ini_data function resolves the file paths and attaches utility methods (get_domain_coords(), squeeze_vertical_dim(), get_time_splits()) as instance methods for use by the LMDZ model 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:

Mandatory arguments#

file : str, mandatory

NetCDF file containing the domain coordinates.

Optional arguments#

dir : str, optional

Directory containing file. Use this argument if file is not in an absolute path.

dir_vcoord : str, optional

Directory containing file_vcoord, if different from dir. Use this argument if the vertical coordinates are not in file and file_vcoord is not in an absolute path.

file_vcoord : str, optional

NetCDF file containing the vertical coordinates. Use this argument if the vertical coordinates are not in file

YAML template#

Please find below a template for a YAML configuration:

 1domain:
 2  plugin:
 3    name: LMDZ
 4    version: regular
 5    type: domain
 6
 7  # Mandatory arguments
 8  file: XXXXX  # str
 9
10  # Optional arguments
11  dir: XXXXX  # str
12  dir_vcoord: XXXXX  # str
13  file_vcoord: XXXXX  # str

See also

API reference (functions & code)