pywaterinfo
Python package to download time series data from waterinfo.be
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found 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 (14.8%) to scientific vocabulary
Keywords
Repository
Python package to download time series data from waterinfo.be
Basic Info
- Host: GitHub
- Owner: fluves
- License: mit
- Language: Python
- Default Branch: master
- Homepage: https://fluves.github.io/pywaterinfo/
- Size: 6.54 MB
Statistics
- Stars: 20
- Watchers: 6
- Forks: 8
- Open Issues: 4
- Releases: 11
Topics
Metadata Files
README.md
pywaterinfo
Python package to download time series data from waterinfo.be
Description
pywaterinfo facilitates access to waterinfo.be, a website managed by the Flanders Environment Agency (VMM) and Flanders Hydraulics Research. The website provides access to real-time water and weather related environmental variables for Flanders (Belgium), such as rainfall, air pressure, discharge, and water level. The package provides functions to search for stations and variables, and download time series.
Check out the documentation website for more information.
Installation
pip install pywaterinfo
Example
To initialize data requests from VMM, setup the Waterinfo class with vmm as input:
from pywaterinfo import Waterinfo
vmm = Waterinfo("vmm")
The time series provided by waterinfo are all defined by a unique identifier called ts_id. Each combination of a given variable (e.g. air pressure)
measured at a given location (e.g. Overpelt) with a certain frequency (e.g. 15min) is defined by an ts_id identifier. Using such an identifier,
one can download the data of a given period with the command get_timeseries_values(). For example, the 15min air pressure time series
at Overpelt has identifier ts_id = 78124042. To get last day of data for the time series with ID 78124042:
df = vmm.get_timeseries_values(78124042, period="P1D")
pywaterinfo returns the data as a Pandas DataFrame, which provides functionlities to plot and manipulate the time series.
Requesting data from from HIC is very similar:
```
hic = Waterinfo("hic") ```
Get last day of data for the time series with ID 39496010, corresponding to high-resolution (5min) conductivity measurements in Dendermonde:
df = hic.get_timeseries_values(ts_id="39496010", period="P1D")
Next to the request of time series data for a given time series identifier, other
requests are supported as well. These functions provide multiple ways to search for the
ts_id you need to download certain data. See the documentation website for more info.
Note on restrictions of the downloads
The amount of data downloaded from waterinfo.be is limited via a credit system. You do not need to get a token right away to download data. For limited and irregular downloads, a token will not be required.
When you require more extended data requests, please request a download token from the waterinfo.be site administrators via the e-mail address hydrometrie@waterinfo.be with a statement of which data and how frequently you would like to download data. You will then receive a client-credit code that can be used to obtain a token that is valid for 24 hours, after which the token can be refreshed with the same client-credit code. The handling of this token is done by
the package itself, but it is important to use the code when initializing the Waterinfo instance. For example, using a VMM token:
from pywaterinfo import Waterinfo
vmm_token = "YOUR TOKEN CODE"
vmm = Waterinfo("vmm", token=vmm_token)
Contribute
Want to contribute code or functionalities to the pywaterinfo package? Great news! Check out the contributing guidelines and the development guidelines in the documentation website.
Acknowledgements
The package development and maintenance is supported by Fluves. Part of the initial development of this package has been supported by VITO.
This package is just a small wrapper around waterinfo.be to facilitate researchers and other stakeholders in downloading the data from waterinfo.be. The availability of this data is made possible by de Vlaamse Milieumaatschappij, Waterbouwkundig Laboratorium, Maritieme Dienstverlening & Kust, Waterwegen en Zeekanaal NV en De Scheepvaart NV.
Meta
- We welcome contributions including bug reports.
- License: MIT
- Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
This project has been set up using PyScaffold 3.2.3. For details and usage information on PyScaffold see https://pyscaffold.org/.
Citation (CITATION.cff)
cff-version: 1.2.0
title: pywaterinfo
message: 'If you use this software, please cite it as below.'
type: software
authors:
- given-names: Stijn
family-names: 'Van Hoey'
email: stijn@fluves.com
affiliation: Fluves
orcid: 'https://orcid.org/0000-0001-6413-3185'
- given-names: Johan
family-names: 'Van de Wauw'
email: johan@fluves.com
affiliation: Fluves
orcid: 'https://orcid.org/0000-0003-0150-3315'
- given-names: Bino
family-names: Maiheu
affiliation: VMM
orcid: 'https://orcid.org/0000-0002-9175-1306'
repository-code: 'https://github.com/fluves/pywaterinfo'
url: 'https://fluves.github.io/pywaterinfo/'
repository-artifact: 'https://pypi.org/project/pywaterinfo/'
abstract: >-
Python package to download time series data from
waterinfo.be
keywords:
- water
- weather
- open data
license: MIT
GitHub Events
Total
- Watch event: 3
- Issue comment event: 3
- Pull request event: 1
- Fork event: 2
Last Year
- Watch event: 3
- Issue comment event: 3
- Pull request event: 1
- Fork event: 2
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Stijn Van Hoey | s****n@f****m | 148 |
| Stijn Van Hoey | s****y@g****m | 29 |
| Johan Van de Wauw | j****n@g****e | 5 |
| Johan Van de Wauw | j****n@f****m | 3 |
| Bino Maiheu | b****u@v****e | 3 |
| Bino Maiheu | b****u@g****m | 2 |
| DBuekenhout | d****t@h****m | 1 |
| Daan Buekenhout | 7****t | 1 |
| Stijn Van Looy | s****y@v****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 27
- Total pull requests: 44
- Average time to close issues: 5 months
- Average time to close pull requests: about 1 month
- Total issue authors: 11
- Total pull request authors: 5
- Average comments per issue: 3.0
- Average comments per pull request: 1.41
- Merged pull requests: 40
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 3
- Pull requests: 2
- Average time to close issues: about 1 month
- Average time to close pull requests: 11 days
- Issue authors: 2
- Pull request authors: 2
- Average comments per issue: 2.0
- Average comments per pull request: 4.5
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- stijnvanhoey (14)
- johanvdw (2)
- nielsdevleeschouwer (2)
- frievb (2)
- Olivia-WB (1)
- olivierbonte (1)
- arnoutr (1)
- JoniDH (1)
- stijnvanlooy (1)
- Jornvdv (1)
Pull Request Authors
- stijnvanhoey (30)
- johanvdw (11)
- binomaiheu (3)
- dbkhout (2)
- TimFranken (1)
- stijnvanlooy (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 373 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 12
- Total maintainers: 2
pypi.org: pywaterinfo
Python package to download time series data from waterinfo.be
- Homepage: https://github.com/fluves/pywaterinfo
- Documentation: https://github.com/fluves/pywaterinfo
- License: mit
-
Latest release: 0.8.1
published over 1 year ago
Rankings
Dependencies
- pandas
- requests
- requests-cache
- actions/checkout v2 composite
- actions/github-script v1 composite
- actions/checkout v2 composite
- actions/setup-python v1 composite
- actions/checkout v2 composite
- actions/setup-python v1 composite
- peaceiris/actions-gh-pages v3 composite
- actions/checkout v2 composite
- actions/setup-python v1 composite
- peaceiris/actions-gh-pages v3 composite