Skip to main content

hydrosensenet

An Open-Source Python Package for Optimal Hydrological Monitoring Network Design

⚠️ In active development

Installation

Requires Python >= 3.9.

pip install hydrosensenet

# With optional extras:
pip install "hydrosensenet[viz]"   # map plotting (matplotlib, cartopy)
pip install "hydrosensenet[nwm]"   # NWM streamflow download stack (fsspec, dask, pynhd, ...)

The core install covers network design, evaluation, and I/O. NetworkDesignResult.plot() and the NWM download utilities tell you which extra to install if it is missing.

Development

git clone https://github.com/future-water/hydrosensenet.git
cd hydrosensenet
pip install -e ".[dev]"   # editable install with tests, linting, build tooling
pytest                    # run the test suite

Quick Start

Examples

Basic Usage

Try it immediately on the bundled sample basin (368 reaches of the lower Colorado River, Texas — NWM v3.0 daily streamflow):

from hydrosensenet import SensorNetworkDesigner, load_example_basin

streamflow_df, locations_gdf = load_example_basin()
designer = SensorNetworkDesigner(streamflow_df, locations_gdf)
result = designer.design_network(n_sensors=20)
result.print_summary()

Or with your own data:

from hydrosensenet import SensorNetworkDesigner
from hydrosensenet.io import load_streamflow
import geopandas as gpd

# Load data
streamflow_df = load_streamflow("streamflow_2000.parquet")
locations_gdf = gpd.read_file("gauges.geojson")

# Design network
designer = SensorNetworkDesigner(
    streamflow_data=streamflow_df.values,
    locations=locations_gdf,
    location_labels=list(streamflow_df.columns)
)
result = designer.design_network(n_sensors=50, evaluate=True)
result.print_summary()

Download files

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

Source Distribution

hydrosensenet-0.2.0.tar.gz (68.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hydrosensenet-0.2.0-py3-none-any.whl (59.5 kB view details)

Uploaded Python 3

File details

Details for the file hydrosensenet-0.2.0.tar.gz.

File metadata

  • Download URL: hydrosensenet-0.2.0.tar.gz
  • Upload date:
  • Size: 68.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for hydrosensenet-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ae82bd85d97e841446c7827d8683e558e80e55dfe6490aab2942e64d3bf1d3b6
MD5 808faf0132d96ba3e53a0bd57408ea23
BLAKE2b-256 e624a7b010b2d734d72fd3329e67b487889289ff24b3d1e256efccbcf6cc8aed

See more details on using hashes here.

Provenance

The following attestation bundles were made for hydrosensenet-0.2.0.tar.gz:

Publisher: publish.yml on future-water/hydrosensenet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hydrosensenet-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: hydrosensenet-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 59.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for hydrosensenet-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68d4c80ee9e324d317cdf2e0ada3535e89bcfd8f3fa507893a3d09336ee05c96
MD5 6b9a0201e505aef52d8c2a5689c17b23
BLAKE2b-256 b6a772085c728d15d88d35b085a7a47fb24484dad065260d6157023c760c0ac8

See more details on using hashes here.

Provenance

The following attestation bundles were made for hydrosensenet-0.2.0-py3-none-any.whl:

Publisher: publish.yml on future-water/hydrosensenet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page