ice_shelf_state_and_fate.timeseries_module_entrypoint

Entrypoint for timeseries module.

Functions

main(label, dataset_paths, output_path, ...)

Process a GeoZarr dataset into a timeseries.
main(label: str, dataset_paths: list[ZarrType], output_path: Path, measurement_name: str, measurement_uncertainty_name: str | None = None, mask_json_path: Path | None = None, apply_mask: bool = True, timeseries_type: TimeseriesType = TimeseriesType.CUMULATIVE, aggregate: AggregationStrategy = AggregationStrategy.MEAN, period: AggregationPeriod | None = AggregationPeriod.MONTH, uncertainty: UncertaintyType | None = None, independent: bool = False, t0_normalisation: NormalisationType | None = None) → None

Process a GeoZarr dataset into a timeseries.

Parameters:

  • label (str) – Label for the timeseries.

  • dataset_paths (list[ZarrType]) – Paths or URLs to the input dataset .zarr files. Can be local paths or URLs.

  • output_path (Path) – Path to save the output .zarr file.

  • measurement_name (str) – Name of the measurement to extract from the dataset.

  • measurement_uncertainty_name (str | None) – Name of the uncertainty to extract from the dataset.

  • mask_json_path (Path | None) – Path to the mask geometry GeoJSON file.

  • apply_mask (bool) – Whether the mask will be used to filter the data. Otherwise, the mask is only used to calculate coverage.

  • timeseries_type (TimeseriesType) – Type of timeseries to compute (cumulative or derivative).

  • aggregate (AggregationStrategy) – Aggregation strategy to apply when multiple measurements fall within the same time bin.

  • period (AggregationPeriod | None) – Time period for aggregation. If None, a single value will be computed for the entire timeseries.

  • uncertainty (UncertaintyType | None) – The statistics type describing the uncertainty.

  • independent (bool) – Whether the uncertainties are independent or not.

  • t0_normalisation (NormalisationType | None) – The type of normalisation to apply against time zero, if any.

Raises:

ValueError – If no timeseries data is available after processing the input datasets.