Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

Hydropandas

A Python package for reading, analyzing, and writing hydrological time series from a Pandas DataFrame, with all of its wonderful features, and extended with custom methods and attributes related to hydrological time series.
https://github.com/artesiawater/hydropandas

Category: Hydrosphere
Sub Category: Ocean and Hydrology Data Access

Keywords

data groundwater hydrology observations pandas timeseries

Keywords from Contributors

flopy geopandas groundwater-modelling hydrogeology modflow pastas arctic data-management articles poster

Last synced: about 14 hours ago
JSON representation

Repository metadata

Module for loading observation data into custom DataFrames

readme.md

PyPi
PyPi Supported Python Versions

Ruff

hydropandas
Codacy Badge
Codacy Badge
Documentation Status

HydroPandas

Hydropandas is a Python package for reading, analyzing and writing
(hydrological) timeseries.

Reading

The HydroPandas package provides convenient read functions from various sources.
The table below lists all API-accessible sources. Click a link in the first column
for the documentation. The "API available" column indicates current availability
(updated weekly).

source observations API available location
BRO Groundwater BRO Netherlands
KNMI Meteorological KNMI Netherlands
Lizard (Vitens) Groundwater Lizard Netherlands (Vitens)
Lizard (Rotterdam) Groundwater Lizard Rotterdam
Matroos Surface water Matroos Netherlands and neighbours
Waterconnect Groundwater Waterconnect South Australia
Waterinfo Surface water quantity and quality Waterinfo Netherlands

Some sources also provide files readable by HydroPandas.

source observations file format location
BRO Groundwater xml Netherlands
DINO Groundwater / surface water csv Netherlands
FEWS Groundwater / surface water xml Netherlands
KNMI Meteorological txt Netherlands
Pastastore Time series models NA NA
Waterinfo Surface water quantity and quality csv / zip Netherlands
Wiski (no docs available) Groundwater csv Netherlands

Install

Install the module with pip:

pip install hydropandas

For some functionality additional packages are required. Install all optional packages:

pip install hydropandas[full]

For installing in development mode, clone the repository and install by
typing pip install -e .[full] from the module root directory.

Documentation

Get in touch

Structure

The HydroPandas package allows users to store a timeseries and metadata in a
single object (Obs class). Or store a collection of timeseries with metadata
in a single object (ObsCollection class). Both inheret from a pandas DataFrame
and are extended with custom methods and attributes related to hydrological timeseries.

The Obs class

The Obs class holds the measurements and metadata for one timeseries. There are
currently 7 specific Obs classes for different types of measurements:

  • GroundwaterObs: for groundwater measurements
  • WaterQualityObs: for groundwater quality measurements
  • WaterlvlObs: for surface water level measurements
  • ModelObs: for "observations" from a MODFLOW model
  • MeteoObs: for meteorological observations
  • PrecipitationObs: for precipitation observations, subclass of MeteoObs
  • EvaporationObs: for evaporation observations, subclass of MeteoObs

Each of these Obs classes is essentially a pandas DataFrame with additional
methods and attributes related to the type of measurement that it holds.
Each Obs object also contains specific methods to read data from specific sources.

The ObsCollection class

The ObsCollection class hold the data for a collection of Obs classes, e.g.
10 timeseries of the groundwater level in a certain area. The
ObsCollection is essentialy a pandas DataFrame in which each timeseries is stored
in a different row. Each row contains metadata (e.g. latitude and longitude
of the observation point) and the Obs object that holds the
measurements. It's recommended to use one ObsCollection per observation type — for
example, group 10 GroundwaterObs in one collection and 5 PrecipitationObs in another.

More information on dealing with Obs and ObsCollection objects in the documentation

Authors

  • Onno Ebbens, Artesia
  • Ruben Caljé, Artesia
  • Davíd Brakenhoff, Artesia
  • Martin Vonk, Artesia

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: about 2 months ago

Total Commits: 1,389
Total Committers: 11
Avg Commits per committer: 126.273
Development Distribution Score (DDS): 0.413

Commits in past year: 220
Committers in past year: 5
Avg Commits per committer in past year: 44.0
Development Distribution Score (DDS) in past year: 0.218

Name Email Commits
OnnoEbbens o****s@g****m 815
dbrakenhoff d****f@a****l 282
Martin Vonk v****t@g****m 222
Mattijs Borst m****t@c****l 28
Hendrik Meuwese 1****W 17
Floris van 't Klooster 6****r 8
Artesia Water 3****r 7
Ruben Caljé r****e@a****l 6
anouksprong a****g@v****l 2
Thomas Berends t****s@h****m 1
Justin Jent j****r@g****m 1

Committer domains:

Issue and Pull Request metadata

Last synced: 2 months ago

Total issues: 116
Total pull requests: 209
Average time to close issues: 5 months
Average time to close pull requests: 4 days
Total issue authors: 18
Total pull request authors: 10
Average comments per issue: 1.75
Average comments per pull request: 0.9
Merged pull request: 186
Bot issues: 0
Bot pull requests: 0

Past year issues: 25
Past year pull requests: 73
Past year average time to close issues: 10 days
Past year average time to close pull requests: 4 days
Past year issue authors: 8
Past year pull request authors: 5
Past year average comments per issue: 1.64
Past year average comments per pull request: 1.14
Past year merged pull request: 59
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/artesiawater/hydropandas

Top Issue Authors

  • OnnoEbbens (53)
  • martinvonk (17)
  • dbrakenhoff (14)
  • HMEUW (9)
  • MattBrst (4)
  • rubencalje (3)
  • jvansijl (2)
  • Florisklooster (2)
  • JaccoHoogewoud (2)
  • ArtemisRo (2)
  • markvdbrink (1)
  • thomas-wsbd (1)
  • anouksprong (1)
  • pimvansanten (1)
  • tdmeij (1)

Top Pull Request Authors

  • OnnoEbbens (124)
  • dbrakenhoff (33)
  • martinvonk (21)
  • Florisklooster (8)
  • HMEUW (8)
  • MattBrst (7)
  • rubencalje (2)
  • ArtesiaWater (2)
  • tberends (2)
  • anouksprong (2)

Top Issue Labels

  • enhancement (16)
  • bug (5)
  • code quality (3)
  • question (2)
  • help wanted (1)
  • documentation (1)
  • wontfix (1)

Top Pull Request Labels

  • enhancement (18)
  • bug (3)
  • code quality (3)

Package metadata

proxy.golang.org: github.com/artesiawater/hydropandas

proxy.golang.org: github.com/ArtesiaWater/hydropandas

pypi.org: hydropandas

Module by Artesia for loading observation data into custom DataFrames.

  • Homepage:
  • Documentation: https://hydropandas.readthedocs.io/
  • Licenses: The MIT License (MIT) Copyright (c) 2020-2025 O.N. Ebbens, D.A. Brakenhoff, R. Calje Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.17.0 (published about 2 months ago)
  • Last Synced: 2025-10-29T20:20:30.578Z (about 2 months ago)
  • Versions: 44
  • Dependent Packages: 3
  • Dependent Repositories: 1
  • Downloads: 3,462 Last month
  • Rankings:
    • Dependent packages count: 3.156%
    • Downloads: 8.785%
    • Average: 11.183%
    • Dependent repos count: 21.607%
  • Maintainers (2)

Dependencies

docs/requirements.txt pypi
  • Ipython *
  • docutils <0.18
  • flopy *
  • ipykernel *
  • nbsphinx *
  • nbsphinx_link *
  • netCDF4 *
  • pastastore *
  • sphinx_rtd_theme *
  • tqdm *
  • xarray *
requirements.txt pypi
  • bokeh *
  • branca *
  • flopy *
  • folium *
  • geopandas *
  • ipykernel *
  • lxml *
  • matplotlib >=3.0
  • nbconvert *
  • nbformat *
  • netCDF4 ==1.5.7
  • numpy >=1.15
  • pandas *
  • pastas *
  • pastastore *
  • pyproj *
  • requests *
  • scipy >=1.2
  • shapely *
  • tqdm *
  • xarray *
  • zeep *
setup.py pypi
  • scipy *

Score: 14.99187986718912