Skip to main content

Module by Artesia for loading observation data into custom DataFrames.

Project description

Artesia

PyPi PyPi Supported Python Versions Binder

hydropandas Codacy Badge Codacy Badge Documentation Status

Format: isort Format: Black Linter: flake8 Linter: ruff

HydroPandas

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

Introduction

The HydroPandas package allows users to store a timeseries and metadata in a single object. This object inherits from a pandas DataFrame, with all its wonderful features, and is extended with custom methods and attributes related to hydrological timeseries.

The HydroPandas package also provides convenient read functions for Dutch hydrological data from:

Install

Install the module with pip:

pip install hydropandas

HydroPandas requires pandas, scipy, matplotlib, tqdm, requests and colorama.

For some functionality additional packages are required:

  • geopandas: for dealing with shapefiles
  • pastastore: for reading or storing data from PastaStore
  • bokeh, branca, folium: for interactive maps
  • flopy: for reading data from MODFLOW models
  • xarray: for loading data from REGIS

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

Get in touch

Examples

Importing a groundwater time series from the BRO using the BRO-id and the tube number:

import hydropandas as hpd
gw_bro = hpd.GroundwaterObs.from_bro("GMW000000041261", 1)

Or import all groundwater time series from the BRO within a certain extent:

oc = hpd.read_bro(extent=(117850, 118180, 439550, 439900))

The Obs class

The Obs class holds the measurements and metadata for one timeseries. There are currently 5 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 contain specific methods to read data from specific sources.

The ObsCollection class

The ObsCollection class, as the name implies, represents a collection of Obs classes, e.g. 10 timeseries of the groundwater level in a certain area. The ObsCollection is also 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 (DataFrame) that holds the measurements. It is recommended to let an ObsCollection contain only one Obs type, e.g. to create an ObsCollection for 10 GroundwaterObs, and a separate ObsCollection for 5 PrecipitationObs.

Like the Obs class, the ObsCollection class contains a bunch of methods for reading data from different sources. See the next section for supported data sources.

Authors

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hydropandas-0.9.1.tar.gz (122.4 kB view details)

Uploaded Source

Built Distribution

hydropandas-0.9.1-py3-none-any.whl (121.0 kB view details)

Uploaded Python 3

File details

Details for the file hydropandas-0.9.1.tar.gz.

File metadata

  • Download URL: hydropandas-0.9.1.tar.gz
  • Upload date:
  • Size: 122.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for hydropandas-0.9.1.tar.gz
Algorithm Hash digest
SHA256 54c4451b2cfbb9e498728323e90e3c0ba22a8f571174778a8ae8177d893f55a2
MD5 b784fdcb308e7be68fe0b6fc64043fa2
BLAKE2b-256 598efcb5cdc9d66220725570de0b58d5ac2c1925a9b9819c6fcd92901ec91c3d

See more details on using hashes here.

File details

Details for the file hydropandas-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: hydropandas-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 121.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for hydropandas-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f8a3a33cb4daa21cb4fee9a5fa568aabe0e9d6fda6413780af23ba5c8334ac04
MD5 30cd09c5beb3851c089ec3d26f13d67c
BLAKE2b-256 877315a9a6225a31aa090e5bcdfd4296923d9d5c87333cec31b6f5090ea0b135

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page