sea_level_response.prepare_gridded_ds_for_selrem_entrypoint

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

Functions

main(gridded_dataset_geozarr, output_path[, ...])

Command line entry point for the prepare gridded data for SELREM.
main(gridded_dataset_geozarr: ZarrType, output_path: Path, coarsen_factor: int = 1) → None

Command line entry point for the prepare gridded data for SELREM.

This allows external workflows to prepare gridded datasets for SELREM processing. This is included to prevent the need for other modules to import the sea_level_response module directly.

Parameters:

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

  • output_path (Path) – Where to save the generated point dataset zarr.

  • 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 the coarsen factor is less than 1.