sea_level_response.selrem_entrypoint

Command line interface entry point for the SELREM module –> for global computation only.

Functions

main(mass_balance_geozarr, start_time, ...)

Command line entry point for the SELREM module (global data).
main(mass_balance_geozarr: ZarrType, start_time: datetime, end_time: datetime, analysis_mode: Literal['global', 'annual'], output_path: Path, scaling_factor: float = 1.0, coarsen_factor: int = 1) → None

Command line entry point for the SELREM module (global data).

Parameters:

  • mass_balance_geozarr (ZarrType) – Location of a GeoZarr dataset containing VMB data in kg. Can be a local path or a web URL.

  • start_time (datetime) – Start time for the time window.

  • end_time (datetime) – End time for the time window.

  • analysis_mode (Literal["global", "annual"]) – Whether to compute global mean SLR or annual gridded SLR.

  • output_path (Path) – Where to save the output sea level rise zarr.

  • scaling_factor (float) – Scaling factor to apply to mass balance values. Default is 1.0.

  • coarsen_factor (int) – Spatial coarsening factor applied before flattening (gridded input only). Mass is summed (mass-conserving); coordinates are averaged; uncertainties are aggregated using RSS/N. Default 1 (no coarsening).

Raises:

ValueError – If an unknown analysis mode is specified.