Gridded NetCDF domain (gridded_netcdf / std)

Description

Reads domain from a gridded NetCDF file

This plugin read the ‘latitude x longitude’ or ‘level x latitude x longitude’ domain from NetCDF files coordinates.

The latitude and longitude coordinate can be infered by their standard_name or long_name attribute (which should be 'latitude' or 'longitude'), Otherwise, .

If the latitude or longitude variable has a bounds attribute, the cell bounds are read from the variable given by this bounds attribute (which should be shaped as (n, 2)). Otherwise the bounds are computed with the max/min arguments and the lat/lon coordinates (assuming they represents the cells centers of a regular grid).

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: (mandatory)

NetCDF file containing the grid coordinates

accepted type: <class ‘str’>

Optional arguments

dir: (optional):

Directory containing file

accepted type: <class ‘str’>

dir_vcoord: (optional):

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

accepted type: <class ‘str’>

file_vcoord: (optional)

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

accepted type: <class ‘str’>

vertical_coord: (optional)

ain’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

accepted values:

  • mids: levels mid-points

  • bounds: levels boundaries

vertical_dim_name: (optional): lev

Vertical dimension name in file or file_vcoord

accepted type: <class ‘str’>

sigma_a_var_name: (optional): ap

‘sigma a’ variable name in file or file_vcoord

accepted type: <class ‘str’>

sigma_b_var_name: (optional): bp

‘sigma b’ variable name in file or file_vcoord

accepted type: <class ‘str’>

pressure_unit: (optional)

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

accepted values: [‘Pa’, ‘hPa’]

latitude_varname: (optional): latitude

nate 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').

accepted type: <class ‘str’>

longitude_varname: (optional): longitude

inate 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').

accepted type: <class ‘str’>

latitude_dimname: (optional): latitude

Latitude dimension name in file.

accepted type: <class ‘str’>

longitude_dimname: (optional): longitude

Longitude dimension name in file.

accepted type: <class ‘str’>

use_corners: (optional): False

True if the longitudes and latitudes are used to defined the corners instead of gridcell centers

accepted type: <class ‘str’>

extend_lat: (optional): False

Extend corner latitudes by one cell if nlat_corner != nlat + 1

accepted type: <class ‘str’>

extend_lon: (optional): False

Extend corner longitudes by one cell if nlon_corner != nlon + 1

accepted type: <class ‘str’>

lat_min: (optional): -90.0

Minimum latitude

accepted type: <class ‘float’>

lat_max: (optional): 90.0

Maximum latitude

accepted type: <class ‘float’>

lon_min: (optional): -180.0

Minimum longitude

accepted type: <class ‘float’>

lon_max: (optional): 180.0

Maximum longitude

accepted type: <class ‘float’>

Yaml template

Please find below a template for a Yaml configuration:

 1domain:
 2  plugin:
 3    name: gridded_netcdf
 4    version: std
 5    type: domain
 6
 7  # Mandatory arguments
 8  file: XXXXX
 9
10  # Optional arguments
11  dir: XXXXX
12  dir_vcoord: XXXXX
13  file_vcoord: XXXXX
14  vertical_coord: XXXXX
15  vertical_dim_name: XXXXX
16  sigma_a_var_name: XXXXX
17  sigma_b_var_name: XXXXX
18  pressure_unit: XXXXX
19  latitude_varname: XXXXX
20  longitude_varname: XXXXX
21  latitude_dimname: XXXXX
22  longitude_dimname: XXXXX
23  use_corners: XXXXX
24  extend_lat: XXXXX
25  extend_lon: XXXXX
26  lat_min: XXXXX
27  lat_max: XXXXX
28  lon_min: XXXXX
29  lon_max: XXXXX