Gridded NetCDF initial conditions (gridded_netcdf / std)

Description

Reads initial conditions from a 3D (level x latitude x longitude) gridded NetCDF file

See domain plugin Gridded NetCDF for information required coordinates format in the 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:

Optional arguments

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:

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