Unstructured grid NetCDF domain gridded_netcdf/unstructured

Unstructured grid NetCDF domain gridded_netcdf/unstructured#

Description#

Reads domain from a unstructured grid NetCDF file

Vertical levels information (sigma pressure) is read only if the argument vertical_coord is provided. Vertical levels information can reside in a separate NetCDF file

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 grid coordinates

Optional arguments#

dir : str, optional, default “”

Directory containing file

dir_vcoord : str, optional, default “”

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

file_vcoord : str, optional

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

vertical_coord : “mids” or “bounds”, optional

Read the domain’s vertical levels if this parameter is used. Should be ‘mids’ if the vertical coordinate represents the levels mid-points or ‘bounds’ if the vertical coordinate represents the levels boundaries. If this parameter is not used a domain single vertical level is created

  • “mids”: levels mid-points

  • “bounds”: levels boundaries

vertical_dim_name : str, optional, default “lev”

Vertical dimension name in file or file_vcoord

vertical_dim_type : “sigma_pressure” or “heights”, optional, default “sigma_pressure”

Vertical dimension type

  • “sigma_pressure”: Levels defined with ap/bp sigma pressure coordinates, with p = psurf * bp + ap

  • “heights”: Levels in meters above ground

sigma_a_var_name : str, optional, default “ap”

‘sigma a’ variable name in file or file_vcoord

sigma_b_var_name : str, optional, default “bp”

‘sigma b’ variable name in file or file_vcoord

pressure_unit : “Pa” or “hPa”, optional

pressure units if different from units attributes in sigma `a` variable, should be ``'Pa' or 'hPa'

reverse_vcoord : bool, optional, default False

reverse the vertical coordinate or not

latitude_varname : str, optional, default “latitude”

Latitude coordinate variable name in file. If this argument is not provided, the latitude coordinate is found by its standard_name or long_name attribute (which should be 'latitude').

longitude_varname : str, optional, default “longitude”

Longitude coordinate variable name in file. If this argument is not provided, the longitude coordinate is found by its standard_name or long_name attribute (which should be 'longitude').

latitude_bounds_varname : str, optional

Latitude bounds (vertices) coordinate variable name in file. If this argument is not provided, the latitude coordinate is found with the bounds attribute of the latitude variable.

longitude_bounds_varname : str, optional

longitude bounds (vertices) coordinate variable name in file. If this argument is not provided, the longitude coordinate is found with the bounds attribute of the longitude variable.

YAML template#

Please find below a template for a YAML configuration:

 1domain:
 2  plugin:
 3    name: gridded_netcdf
 4    version: unstructured
 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  vertical_coord: XXXXX  # mids|bounds
15  vertical_dim_name: XXXXX  # str
16  vertical_dim_type: XXXXX  # sigma_pressure|heights
17  sigma_a_var_name: XXXXX  # str
18  sigma_b_var_name: XXXXX  # str
19  pressure_unit: XXXXX  # Pa|hPa
20  reverse_vcoord: XXXXX  # bool
21  latitude_varname: XXXXX  # str
22  longitude_varname: XXXXX  # str
23  latitude_bounds_varname: XXXXX  # str
24  longitude_bounds_varname: XXXXX  # str