Load data from the UK Hydology API
Project description
Hydrology API
This package was build for internal use, please feel free to use it but it may have bugs
This package is designed to read data from the UK government Hydrology API. The API provides:
- River Level, Flow and Water Quality Data
- Rainfall Data
- Groundwater Level Data
This package currently only provides access to the River Level, Flow, and Rainfall.
Example
from hydrology_api import HydrologyAPI, Measure, process_hydrology_data
api = HydrologyApi(max_threads=5)
stations = api.get_stations_on_river('River Wear', Measure.LEVEL)
print(f"Loading data for {len(stations)} stations: {stations['label'].values}")
level_df = api.load(Measure.LEVEL, stations)
level_df = process_hydrology_data(level_df)
level_df.info()
>>> Loading data for 5 stations: ['Chester Le Street' 'Witton Park' 'Sunderland Bridge' 'Stanhope'
'Durham New Elvet Bridge']
>>> Loading from cache: https://environment.data.gov.uk/hydrology/data/batch-readings/batch/?measure=e7d8bbb6-5bba-4057-9f49-a299482c3348-level-i-900-m-qualified&mineq-date=2007-01-01
>>> Loading from cache: https://environment.data.gov.uk/hydrology/data/batch-readings/batch/?measure=05784319-693a-4d75-b29e-32f01a99ee4f-level-i-900-m-qualified&mineq-date=2007-01-01
>>> Loading from cache: https://environment.data.gov.uk/hydrology/data/batch-readings/batch/?measure=ddedb4d9-b2be-47c1-998d-acbc0ffb124b-level-i-900-m-qualified&mineq-date=2007-01-01
>>> Loading from cache: https://environment.data.gov.uk/hydrology/data/batch-readings/batch/?measure=b29c481a-5012-40f5-bb0c-f9370be34975-level-i-900-m-qualified&mineq-date=2007-01-01
>>> Loading from cache: https://environment.data.gov.uk/hydrology/data/batch-readings/batch/?measure=ba3f8598-e654-430d-9bb8-e1652e6ff93d-level-i-900-m-qualified&mineq-date=2007-01-01
>>> <class 'pandas.core.frame.DataFrame'>
>>> DatetimeIndex: 590967 entries, 2007-01-01 00:00:00 to 2023-11-08 21:30:00
>>> Freq: 15T
>>> Data columns (total 5 columns):
>>> # Column Non-Null Count Dtype
>>> --- ------ -------------- -----
>>> 0 Chester Le Street 590967 non-null float16
>>> 1 Durham New Elvet Bridge 563826 non-null float16
>>> 2 Stanhope 501615 non-null float16
>>> 3 Sunderland Bridge 589418 non-null float16
>>> 4 Witton Park 585167 non-null float16
>>> dtypes: float16(5)
>>> memory usage: 10.1 MB
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for hydrology_api_uk_client-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0cbb0141aa197b20e81375251cbaf2d5e3ab026624c3f562dee38a5f7d3cd6d2 |
|
MD5 | 6edeb5a416ed0b1e0d2217464b95691f |
|
BLAKE2b-256 | 72c4621eb0388fe2aeaaa79d8405b62b815bf7461735f68a009c19fb675ee141 |
Close
Hashes for hydrology_api_uk_client-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7eeb7918429822baed716cec5f0fb06debcbd02fa40692ff1bf52570129172a2 |
|
MD5 | c5effc1881080f5c8cf9e300eaaa32e9 |
|
BLAKE2b-256 | fec69b087cc943cc7b6a9fbf6e7ea767bf79bfeaddc4d930cc75dc9b7da3480c |