LMDZ dynamico domain LMDZ/dynamico

LMDZ dynamico domain LMDZ/dynamico#

Description#

LMDZ-Dynamico (icosahedral) domain plugin.

Extends the lmdz_reg (regular lat-lon) plugin with support for the LMDZ icosahedral grid produced by the Dynamico dynamical core.

In addition to the regular grid files (file, file_vcoord), an optional file_mesh provides the Dynamico mesh connectivity. If all three files reside in the same directory, dir is sufficient; otherwise dir_mesh may point to a separate location.

The ini_data function attaches utility methods from pycif.plugins.domains.lmdz_ico.utils directly to the plugin instance for later use by the LMDZ-ico 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

dir_mesh : str, optional

Directory containing file_mesh, if different from dir. Use this argument if the mesh variables are not in file and file_mesh is not in an absolute path.

file_mesh : str, optional

NetCDF file containing the mesh variables. Use this argument if the mesh variables are not in file

YAML template#

Please find below a template for a YAML configuration:

 1domain:
 2  plugin:
 3    name: LMDZ
 4    version: dynamico
 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
14  dir_mesh: XXXXX  # str
15  file_mesh: XXXXX  # str

See also

API reference (functions & code)