veriflow.datasinks.cf_compliant_netcdf#

Read and write netcdf files in a fews compatible format.

Classes

CFCompliantNetCDF(config)

For writing veriflow output to NetCDF.

CFCompliantNetCDFConfig(*, directory, ...[, ...])

A cf-compliant NetCDF output config element.

class veriflow.datasinks.cf_compliant_netcdf.CFCompliantNetCDF(config)[source]#

For writing veriflow output to NetCDF.

This datasink will write one NetCDF file for each verification pair. Input data are included and results are written in NetCDF groups. Each file is named "<stem>_<verification_pair_id> <suffix>", where <stem>/<suffix> are derived from the configured filename.

Note

CF-compliancy is not yet fully implemented.

Parameters:

config (CFCompliantNetCDFConfig)

kind: str = 'cf_compliant_netcdf'#
config_class#

alias of CFCompliantNetCDFConfig

write_data(dt)[source]#

Write the data in the xarray DataTree to the file as specified in the output config.

Parameters:

dt (DataTree)

Return type:

None

classmethod from_config(raw_config)#

Initialize class from config dict.

Parameters:

raw_config (dict[str, Any])

Return type:

Self

class veriflow.datasinks.cf_compliant_netcdf.CFCompliantNetCDFConfig(*, directory, filename, export_adapter, force_overwrite=True, include_output=True, include_aligned_input_data=True, include_input_data=False, crs=None, general, conventions='CF-1.7', title='Verification results created by veriflow', institution, comment='Verification results created by veriflow', **extra_data)[source]#

A cf-compliant NetCDF output config element.

Parameters:
  • directory (Path)

  • filename (str)

  • export_adapter (Literal[DataSinkKind.cf_compliant_netcdf])

  • force_overwrite (bool)

  • include_output (bool)

  • include_aligned_input_data (bool)

  • include_input_data (bool)

  • crs (Annotated[str, FieldInfo(annotation=NoneType, required=True, description="A coordinate reference system as a string compatible with pyproj.CRS.from_string, i.e. a PROJ string, a CRS WKT string, or an authority string such as 'EPSG:4326'. The string is not parsed at configuration time so that pyproj remains an optional dependency; it is only parsed when an actual coordinate transformation is required.", metadata=[MinLen(min_length=1)])] | None)

  • general (Annotated[GeneralInfoConfig, SkipJsonSchema()])

  • conventions (Literal['CF-1.7'])

  • title (str)

  • institution (str)

  • comment (str)

  • extra_data (Any)

export_adapter: Literal[DataSinkKind.cf_compliant_netcdf]#
property verification_period: TimePeriod#
conventions#
title#
institution#
comment#
force_overwrite#
include_output#
include_aligned_input_data#
include_input_data#
crs#
general#
directory#
filename#