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 infileaccepted type: <class ‘str’>
file_vcoord: (optional):
NetCDF file containing the vertical coordinates. Use this argument if the vertical coordinates are not in
fileaccepted type: <class ‘str’>
vertical_coord: (optional):
Read domain’s vertical levels if this parameter is used. Should be ‘mids’ if the vertical coordinate represent the levels mid-points or ‘bounds’ if the vertical coordinate represent the levels boundaries. If this parameter is not used a domain single vertical level is created
accepted values:
mids: TEXT
bounds: TEXT
vertical_coord_name: (optional): lev
Vertical coordinate name in
fileorfile_vcoordaccepted type: <class ‘str’>
sigma_a_var_name: (optional): ap
‘sigma a’ variable name in
fileorfile_vcoordaccepted type: <class ‘str’>
sigma_b_var_name: (optional): bp
‘sigma b’ variable name in
fileorfile_vcoordaccepted type: <class ‘str’>
pressure_unit: (optional):
pressure units if different from
unitsattributes insigma `a` variable, should be ``'Pa'or'hPa'accepted values: [‘Pa’, ‘hPa’]
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’>
longitude_varname: (optional)
Name of the longitude variable
accepted type: <class ‘str’>
latitude_varname: (optional)
Name of the latitude variable
accepted type: <class ‘str’>
longitude_coordname: (optional)
Name of the longitude coordinate
accepted type: <class ‘str’>
latitude_coordname: (optional)
Name of the latitude coordinate
accepted type: <class ‘str’>
use_corners: (optional): False
True is the longitudes and latitudes are used to defined the corners instead of gridcell centers
accepted type: <class ‘str’>
extend_lon: (optional): False
Extend corner longitudes by one cell if nlon_corner != nlon + 1
accepted type: <class ‘str’>
extend_lat: (optional): False
Extend corner latitudes by one cell if nlat_corner != nlat + 1
accepted type: <class ‘str’>
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_coord_name: XXXXX
13 sigma_a_var_name: XXXXX
14 sigma_b_var_name: XXXXX
15 pressure_unit: XXXXX
16 lat_min: XXXXX
17 lat_max: XXXXX
18 lon_min: XXXXX
19 lon_max: XXXXX
20 longitude_varname: XXXXX
21 latitude_varname: XXXXX
22 longitude_coordname: XXXXX
23 latitude_coordname: XXXXX
24 use_corners: XXXXX
25 extend_lon: XXXXX
26 extend_lat: XXXXX
