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: str

Optional arguments

dir: (optional):

Directory containing file

accepted type: str

dir_vcoord: (optional):

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

accepted type: str

file_vcoord: (optional)

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

accepted type: str

vertical_coord: (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

accepted values:

• mids: levels mid-points

• bounds: levels boundaries

vertical_dim_name: (optional): lev

Vertical dimension name in file or file_vcoord

accepted type: str

sigma_a_var_name: (optional): ap

‘sigma a’ variable name in file or file_vcoord

accepted type: str

sigma_b_var_name: (optional): bp

‘sigma b’ variable name in file or file_vcoord

accepted type: 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

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

accepted type: str

longitude_varname: (optional): 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').

accepted type: str

latitude_dimname: (optional): latitude

Latitude dimension name in file.

accepted type: str

longitude_dimname: (optional): longitude

Longitude dimension name in file.

accepted type: str

use_corners: (optional): False

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

accepted type: str

extend_lat: (optional): False

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

accepted type: str

extend_lon: (optional): False

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

accepted type: str

lat_min: (optional): -90.0

Minimum latitude

accepted type: float

lat_max: (optional): 90.0

Maximum latitude

accepted type: float

delta_lat: (optional)

Skip the reading/computation of latitude bounds and use regular gridcells with a size of delta_lat. delta_lat should divide lat_max - lat_min and be coherent with the NetCDF file dimensions.

accepted type: float

lon_min: (optional): -180.0

Minimum longitude

accepted type: float

lon_max: (optional): 180.0

Maximum longitude

accepted type: float

delta_lon: (optional)

Skip the reading/computation of longitude bounds and use regular gridcells with a size of delta_lon. delta_lon should divide lon_max - lon_min and be coherent with the NetCDF file dimensions.

accepted type: float

Yaml template

Please find below a template for a Yaml configuration:

domain:
  plugin:
    name: gridded_netcdf
    version: std
    type: domain

  # Mandatory arguments
  file: XXXXX  # str

  # Optional arguments
  dir: XXXXX  # str
  dir_vcoord: XXXXX  # str
  file_vcoord: XXXXX  # str
  vertical_coord: XXXXX  # mids|bounds
  vertical_dim_name: XXXXX  # str
  sigma_a_var_name: XXXXX  # str
  sigma_b_var_name: XXXXX  # str
  pressure_unit: XXXXX  # Pa|hPa
  latitude_varname: XXXXX  # str
  longitude_varname: XXXXX  # str
  latitude_dimname: XXXXX  # str
  longitude_dimname: XXXXX  # str
  use_corners: XXXXX  # str
  extend_lat: XXXXX  # str
  extend_lon: XXXXX  # str
  lat_min: XXXXX  # float
  lat_max: XXXXX  # float
  delta_lat: XXXXX  # float
  lon_min: XXXXX  # float
  lon_max: XXXXX  # float
  delta_lon: XXXXX  # float