finam_netcdf.Variable#

class finam_netcdf.Variable(name, io_name=None, slices=None, static=None, mask=Ellipsis, crs=Ellipsis, **info_kwargs)[source]#

Specifications for a NetCDF variable.

Parameters:

name (str) – Variable name in the NetCDF file.
io_name (str, optional) – Desired name of the respective Input/Output in the FINAM component. Will be the variable name by default.
slices (dict of str, int, optional) – Dictionary for fixed coordinate indices (e.g. {‘time’: 0})
static (bool or None, optional) – Flag indicating static data. If None, this will be determined. Writer will interprete None as False. Default: None
mask (Mask value or MASK_TBD or Ellipsis, optional) – default masking specification of the data.
Options:
- Ellipsis: use default mask from the component (default)
- finam.Mask.FLEX: data can have a varying mask
- finam.Mask.NONE: data is unmasked and given as plain numpy array
- MASK_TBD: constant mask will be determined from the data
crs (str or None or Ellipsis, optional) – Coordinate reference system to force for the variable. Either a CRS string like EPSG:3035, None for no CRS, or Ellipsis to use the CRS from the NetCDF file. Optional.
**info_kwargs – Optional keyword arguments to instantiate an Info object (i.e. ‘grid’ and ‘meta’) Used to overwrite meta data, to change units or to provide a desired grid specification.

Methods

Get the meta-data dictionary of this variable.