sondera.clients.sgu package

Submodules

sondera.clients.sgu.groundwater module

Client for SGU groundwater levels api https://www.sgu.se/produkter/geologiska-data/oppna-data/grundvatten-oppna-data/grundvattennivaer-tidsserier/

class sondera.clients.sgu.groundwater.GroundwaterLevelsClient[source]

Bases: object

get_all_stations()[source]

get_all_stations_lan(lan_code: SGULanCodes | str)[source]

Get all stations and station metadata for a given län. See Enum SGULanCodes or list_sgu_lan_codes() for list of län codes, alternatively the official documentation of the SGU API (links below).

Notes

https://www.sgu.se/produkter/geologiska-data/oppna-data/grundvatten-oppna-data/grundvattennivaer-tidsserier/

https://resource.sgu.se/dokument/produkter/oppnadata/grundvattennivaer-tidsserier-oppnadata-beskrivning.pdf

get_observations(station_code: str, parameter: ParametersGWLevels = ParametersGWLevels.LevelBelowGroundSurface) → DataSeries[source]

Get data for a given station / groundwater well Returns data for groundwater level below ground surface (parameter LevelBelowGroundSurface) by default.

For station codes also see functions get_all_stations_lan() and get_all_stations().

Parameters:

station_code (str) – SGU station code
parameter (str or ParametersGWLevels Enum.) –
valid Enum and string options are ParametersGWLevels.LevelBelowWellTop : ‘grundvattenniva_cm_u._roroverkant’ ParametersGWLevels.LevelAboveSeaLevel : ‘grundvattenniva_m_o.h.’ ParametersGWLevels.LevelBelowGroundSurface : ‘grundvattenniva_m_under_markyta’

Note that groundwater level above sea level is returned with an unknown vertical datum, official documentation states “usually RH70”.

Return type:

A DataSeries object with observations and station metadata