hydropandas
Module for loading observation data into custom DataFrames
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.0%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Module for loading observation data into custom DataFrames
Basic Info
- Host: GitHub
- Owner: ArtesiaWater
- License: mit
- Language: Python
- Default Branch: dev
- Homepage: https://hydropandas.readthedocs.io
- Size: 46 MB
Statistics
- Stars: 65
- Watchers: 6
- Forks: 12
- Open Issues: 16
- Releases: 46
Topics
Metadata Files
readme.md
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 | 
| Netherlands |
| KNMI | Meteorological | 
| Netherlands |
| Lizard (Vitens) | Groundwater | 
| Netherlands (Vitens) |
| Lizard (Rotterdam) | Groundwater | 
| Rotterdam |
| Waterconnect | Groundwater | 
| South Australia |
| Waterinfo | Surface water quantity and quality | 
| 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
- Documentation is provided on the dedicated website hydropandas.readthedocs.io
- Examples are available in the examples directory on the documentation website
- View and edit the example notebooks of hydropandas in GitHub Codespaces
Get in touch
- Questions on HydroPandas ("How can I?") can be asked and answered on Github Discussions.
- Bugs, feature requests and other improvements can be posted as Github Issues.
- Find out how to contribute to HydroPandas at our Contribution page.
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
- Name: Artesia Water
- Login: ArtesiaWater
- Kind: user
- Location: Schoonhoven, The Netherlands
- Company: Artesia Water
- Website: http://www.artesia-water.nl
- Repositories: 13
- Profile: https://github.com/ArtesiaWater
Artesia adviseert bij hydrologische vraagstukken. We zijn gespecialiseerd in het programmeren van modellen in Python, Matlab en andere bekende programmeertalen.
GitHub Events
Total
- Create event: 35
- Release event: 10
- Issues event: 43
- Watch event: 13
- Delete event: 24
- Issue comment event: 84
- Push event: 180
- Pull request review event: 58
- Pull request review comment event: 27
- Pull request event: 57
Last Year
- Create event: 35
- Release event: 10
- Issues event: 43
- Watch event: 13
- Delete event: 24
- Issue comment event: 84
- Push event: 180
- Pull request review event: 58
- Pull request review comment event: 27
- Pull request event: 57
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| OnnoEbbens | o****s@g****m | 764 |
| dbrakenhoff | d****f@a****l | 280 |
| Martin Vonk | v****t@g****m | 222 |
| Mattijs Borst | m****t@c****l | 26 |
| 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 (Top 20 + Academic)
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 111
- Total pull requests: 201
- 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.68
- Average comments per pull request: 0.84
- Merged pull requests: 180
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 29
- Pull requests: 84
- Average time to close issues: 10 days
- Average time to close pull requests: 3 days
- Issue authors: 10
- Pull request authors: 6
- Average comments per issue: 1.0
- Average comments per pull request: 0.9
- Merged pull requests: 69
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- OnnoEbbens (51)
- martinvonk (17)
- dbrakenhoff (13)
- HMEUW (9)
- rubencalje (3)
- jvansijl (2)
- Florisklooster (2)
- JaccoHoogewoud (2)
- ArtemisRo (2)
- MattBrst (2)
- markvdbrink (1)
- thomas-wsbd (1)
- anouksprong (1)
- pimvansanten (1)
- tdmeij (1)
Pull Request Authors
- OnnoEbbens (119)
- dbrakenhoff (33)
- martinvonk (21)
- Florisklooster (8)
- HMEUW (8)
- MattBrst (4)
- rubencalje (2)
- ArtesiaWater (2)
- tberends (2)
- anouksprong (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 1,733 last-month
-
Total dependent packages: 3
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 121
- Total maintainers: 2
proxy.golang.org: github.com/artesiawater/hydropandas
- Documentation: https://pkg.go.dev/github.com/artesiawater/hydropandas#section-documentation
- License: mit
-
Latest release: v0.15.1
published 9 months ago
Rankings
proxy.golang.org: github.com/ArtesiaWater/hydropandas
- Documentation: https://pkg.go.dev/github.com/ArtesiaWater/hydropandas#section-documentation
- License: mit
-
Latest release: v0.15.1
published 9 months ago
Rankings
pypi.org: hydropandas
Module by Artesia for loading observation data into custom DataFrames.
- Documentation: https://hydropandas.readthedocs.io/
- License: 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.15.1
published 9 months ago
Rankings
Maintainers (2)
Dependencies
- Ipython *
- docutils <0.18
- flopy *
- ipykernel *
- nbsphinx *
- nbsphinx_link *
- netCDF4 *
- pastastore *
- sphinx_rtd_theme *
- tqdm *
- xarray *
- 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 *
- scipy *