geoprior.cli.build_add_zsurf_from_coords#

Build harmonized datasets enriched with surface elevation.

This command merges a main tabular dataset with a coordinate-to- elevation lookup on rounded longitude/latitude pairs, then optionally computes hydraulic head when a depth-below-ground-surface column is available.

Functions

`build_add_zsurf_main`([argv])	CLI entry point for z_surf enrichment.
`enrich_city_dataset`(paths, *, lon_col, ...)	Merge one city dataset with its surface elevation lookup.
`main`([argv])	Command alias entry point.

Classes

CityPaths(city, main_csv, elev_csv)

Resolved input paths for one city.

class geoprior.cli.build_add_zsurf_from_coords.CityPaths(city, main_csv, elev_csv)[source]#

Bases: object

Resolved input paths for one city.

Parameters:

city (str)
main_csv (Path)
elev_csv (Path)

city: str#

main_csv: Path#

elev_csv: Path#

__init__(city, main_csv, elev_csv)#

Parameters:

city (str)
main_csv (Path)
elev_csv (Path)

Return type:

None

geoprior.cli.build_add_zsurf_from_coords.enrich_city_dataset(paths, *, lon_col, lat_col, elev_col, zsurf_col, round_decimals, reducer, compute_head, head_col, args)[source]#

Merge one city dataset with its surface elevation lookup.

Parameters:

paths (CityPaths)
lon_col (str)
lat_col (str)
elev_col (str)
zsurf_col (str)
round_decimals (int)
reducer (str)
compute_head (bool)
head_col (str)
args (Namespace)

Return type:

tuple[DataFrame, dict[str, object]]

geoprior.cli.build_add_zsurf_from_coords.build_add_zsurf_main(argv=None)[source]#

CLI entry point for z_surf enrichment.

Parameters:: argv (list[str] | None)
Return type:: None

geoprior.cli.build_add_zsurf_from_coords.main(argv=None)[source]#

Command alias entry point.

Parameters:: argv (list[str] | None)
Return type:: None