Gridded NetCDF surface flux (gridded_netcdf / std)

Description

Reads surface flux from a 1+2D (time x latitude x longitude) gridded NetCDF files

The provided NetCDF files should all have the exact same latitude x longitude grid. The latitude x longitude grid will only be read from the NetCDF file corresponding to the first simulation sub-period.

The time coordinate should be named 'time' in the NetCDF files.

Either file_freq or is_climatology argument is required.

See Gridded NetCDF domain plugin for information about the 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

file_freq: (optional)

ncy at which data files are available. Should be a multiple of one of Pandas’ offset aliases which will be passed to the pandas.date_range method, ex: ‘1MS’ for every first day of the month

accepted type: <class ‘str’>

is_climatology: (optional): False

Set this argument to True for climatological data (i.e. year-independent data)

accepted type: <class ‘bool’>

var_freq: (optional)

ncy of the flux variable within the NetCDF files. Should be one of Pandas’ offset aliases which will be passed to the pandas.DatetimeIndex.to_period method. This argument may not be needed is the time frequency in the NetCDF files is regular, ex: ‘D’ for daily values

accepted type: <class ‘str’>

remove_duplicates: (optional): True

Remove duplicate files matching the prescribed pattern

accepted type: <class ‘bool’>

time_varname: (optional)

variable name in file. If this argument

is not provided, the time coordinate is found by its standard_name or long_name (which should be 'time'). If the time coordinate cannot be found by its attributes, the variable named 'time' will be used if it exists.

accepted type: <class ‘str’>

time_coordinate: (optional)

Name of the time coordinate if different from the time variable

accepted type: <class ‘str’>

time_unit: (optional)

NetCDF standard time unit, if not specified in the file

accepted type: <class ‘str’>

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  file_freq: XXXXX
10  is_climatology: XXXXX
11  var_freq: XXXXX
12  remove_duplicates: XXXXX
13  time_varname: XXXXX
14  time_coordinate: XXXXX
15  time_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