climate.utils.provenance

Helpers for collecting provenance information from xclim indicators.

Module Contents

climate.utils.provenance.add_indicator_provenance(metadata, indicator, dataset, **kwargs)

Add provenance information from an xclim indicator call to the metadata.

Parameters:
  • metadata (MetadataDict) – Metadata dictionary to update.

  • indicator (Callable) – xclim indicator function used to compute the index.

  • dataset (xarray.Dataset) – Dataset passed to the indicator.

  • **kwargs (Any) – Keyword arguments passed to the indicator.

Returns:

The updated metadata dictionary.

Return type:

MetadataDict