Skip to main content
AquaScope logo

AquaScope

Open-source Python toolkit for water data, hydrology, and agricultural water management — with an AI engine that recommends and auto-executes research methodologies.

CI Pyodide PyPI version Python License: MIT DOI Code style: ruff Tests Live Explorer Demo – Runs in Your Browser

GitHub stars GitHub forks

🌊 Live Explorer Demo - Runs in Your Browser, No Install Required · Install · Examples · CLI · Features · Docs · Roadmap · Discussions

Support on Ko-fi if AquaScope helps your research.

🌐 Read this in: Français


AquaScope unifies 37 global water-data sources behind one Python schema, then layers a full scientific computing stack on top — from Bulletin 17C flood frequency to FAO-56 crop water requirements — wrapped in an AI engine that scores 26 research methodologies against your dataset and auto-executes 26 analysis pipelines. Validated against the CAMELS benchmark with 2,500+ tests.


🌍 Try it without installing anything

AquaScope Explorer: every public gauge we can reach on one map (62,613 stations from USGS, Australia BOM, UK EA, Hub'Eau, Taiwan CWA, PEGELONLINE and Ireland OPW; Greece and Brazil land with the next weekly rebuild). Click one and get the observed record, flood frequency with confidence limits, flow duration and trend, computed in your browser by aquascope on Pyodide. The catalog behind it is an open GeoParquet dataset, Rekin226/aquascope-gauges, harvested weekly. Press Ask ✨ to type a question in plain language (bring your own key, Groq and Hugging Face are free): the model picks the tools, aquascope runs them in your browser, and the answer ends with the data used and the methods with citations. Press Study (or "Study this place" on any gauge or point) to hand a whole problem to a crew of roles: it writes the brief with you, inventories the data in reach and the table you drop in, proposes a methodology you approve, runs it with a check after every step (a failed check fails that step, the rest still runs), reads the results the way an engineer would (findings that each point at the number they rest on, a decision with its band and a grade, what would change it, the data it would ask for), asks for data instead of declining when a table of yours would unlock the question, and hands back a zip with a Word report, an Excel workbook, PNG and SVG figures, a notebook that re-runs the study and the study.yaml. Keyless it still does all of that from the playbooks, and with the on-device model Ask already loads it plans and writes on your machine; your own key puts a model behind every role. Twelve recorded studies on the board show what a full run looks like and re-run live in your browser (docs). Not a Python user? The same files open in R, QGIS, DuckDB and Julia in place; integrations/qgis/ has a drag-and-drop layer definition.

Prefer an assistant? pip install "aquascope[mcp]" then claude mcp add aquascope -- aquascope mcp gives Claude (or any MCP client) find_stations, get_timeseries, analyze_station and flood_frequency over the same catalog and methods (docs).

✨ What you can do

  • 🌊 Pull water data from USGS, NOAA NWPS, Colorado DWR/CDSS, US Water Quality Portal, England's Environment Agency, France Hub'Eau, Germany PEGELONLINE, Ireland OPW, Greece Hydroscope and OpenHi.net, Poland IMGW-PIB, EU WFD, Taiwan MOENV/WRA/CWA/Civil IoT/DataGov, Japan MLIT, Korea WAMIS, India WRIS, South Africa DWS, Australia BOM, Brazil ANA Hidroweb, CAMELS-CL and CAMELS-BR, GRDC, GEMStat, Copernicus ERA5, OpenMeteo, FAO AQUASTAT, FAO WaPOR and UN SDG 6 — one unified Python API.
  • 📈 Run hydrological analyses — Bulletin 17C flood frequency (GEV / LP3 / Gumbel / non-stationary GEV / EMA), baseflow separation, rating curves, 22 hydrological signatures.
  • 🌾 Plan agricultural water — FAO-56 Penman-Monteith ET₀, crop water requirements for 26 crops, irrigation scheduling, soil water balance with auto-irrigation.
  • 🤖 Ask the AI engine — describe your goal in plain English and get a recommended methodology, scored against your dataset profile and auto-executed. LLM enhancement via OpenAI, Groq (free), HuggingFace (free), or local Ollama.
  • 🧑‍🔬 Hand a study to the crew — aquascope studio "PROBLEM" --lat --lon: a Consultant, a Scout, a Methodologist, Analysts, an Interpreter, a Critic and an Author over one workspace, the plan shown before it runs, every step gated (a failed gate fails its step, not the study), every answer graded (established, indicative, screening, not established) with findings that point at the result they rest on, a request for the data that would unlock a question instead of a decline, and the bundle (Word, Excel, figures, notebook, findings.json, study.yaml) at the end. Also in the Explorer and over MCP.
  • 📊 Visualise + report — 16 plot types, Q-Q / P-P diagnostics, Markdown / HTML reports with embedded figures, threshold alerts (WHO / EPA / EU WFD).
  • 🗺️ Spatial hydrology — DEM processing, D8 flow direction, watershed delineation, Strahler ordering.

For the full capability list see docs/features.md.

📊 Why AquaScope

AquaScope HEC-SSP R lmom Standalone collectors
Bulletin 17C FFA + EMA ✅ ✅ partial —
Non-stationary GEV ✅ — partial —
Baseflow separation (Lyne-Hollick, Eckhardt) ✅ — — —
FAO-56 Penman-Monteith ET₀ + crop water ✅ — — —
37 unified data collectors ✅ — — per-source
AI methodology recommender (OpenAI / Groq / HF / Ollama) ✅ — — —
Interactive Streamlit dashboard ✅ — — —
Free, MIT, Python-native ✅ partial ✅ varies

⚡ Install

pip install aquascope              # core — collectors + hydrology
pip install "aquascope[all]"       # everything — ML, viz, spatial, dashboard

Feature-group extras:

pip install "aquascope[ml]"           # sklearn, xgboost, statsmodels
pip install "aquascope[viz]"          # matplotlib, seaborn, folium
pip install "aquascope[scientific]"   # xarray, netcdf4, h5py
pip install "aquascope[interop]"      # xarray + geopandas (collect as_xarray / as_geodataframe)
pip install "aquascope[spatial]"      # rasterio, geopandas, shapely
pip install "aquascope[dashboard]"    # streamlit
pip install "aquascope[forecast]"     # prophet, torch (for LSTM)

For development:

git clone https://github.com/Rekin226/aquascope.git
cd aquascope
pip install -e ".[all,dev]"

🚀 Examples

1. Flood frequency analysis (Bulletin 17C)

from aquascope.api import flood_analysis

result = flood_analysis(daily_discharge, method="gev", return_periods=[10, 50, 100])
print(result.return_periods)
# {10: 1840.2, 50: 2530.7, 100: 2870.4}
print(result.confidence_intervals)
# {10: (1690.4, 2010.6), 50: (2280.1, 2820.9), 100: (2540.6, 3260.5)}

Switch method to "lp3", "gumbel", "gev_lmoments", or "gpd". Non-stationary GEV (fit_nonstationary_gev) and Bulletin 17C EMA for censored records (expected_moments_algorithm) are available in aquascope.hydrology.flood_frequency.

2. Baseflow separation + hydrological signatures

from aquascope.api import baseflow_analysis, compute_all_signatures

bf  = baseflow_analysis(daily_discharge, method="eckhardt")   # or "lyne_hollick"
sig = compute_all_signatures(daily_discharge)

print(bf.bfi)                  # baseflow index, e.g. 0.42
print(sig.q5, sig.q95)         # high-flow / low-flow exceedances
print(sig.flashiness_index)    # Richards-Baker flashiness index

22 signatures across magnitude, variability, timing, recession, and flashiness — see docs/features.md.

3. Collect data from any of the 37 sources

from aquascope import find_stations
from aquascope.collectors import USGSCollector, AquastatCollector, WaPORCollector

# Which gauges measure discharge around Greater London? (USGS, UK EA, Hub'Eau,
# PEGELONLINE, Ireland OPW, Greece (Hydroscope + OpenHi.net) and Taiwan CWA
# expose station catalogs; more coming)
gauges = find_stations(bbox=(-0.5, 51.3, 0.3, 51.7), variable="discharge")
print(gauges[0].name, gauges[0].url)

usgs = USGSCollector()   # pass api_key=... for reliable access
flow = usgs.collect(days=7, bbox="-77.6,38.7,-76.9,39.1")   # Potomac basin, last week

aquastat = AquastatCollector()
egy_water = aquastat.collect(country_code="EGY", variable_ids=[4263, 4253, 4312])

wapor = WaPORCollector()
et = wapor.collect(
    bbox=(30.5, 29.8, 31.1, 30.2),
    variable="RET",
    start_date="2026-04-01",
    end_date="2026-07-31",
)

Every collector returns records in the same Pydantic schema, so downstream analyses don't care where the data came from. See docs/data_sources.md for the full list.

4. FAO-56 crop water requirements + soil water balance

from datetime import date
from aquascope.agri import (
    penman_monteith_daily,
    crop_water_requirement,
    SoilWaterBalance,
)
from aquascope.agri.water_balance import SoilProperties

# Reference ET (FAO-56 Penman-Monteith) — Cairo, July
eto = penman_monteith_daily(
    t_min=18.0, t_max=32.0, rh_min=40, rh_max=80,
    u2=2.0, rs=22.0, latitude=30.0, elevation=70, doy=180,
)

# Crop water requirement for maize from planting through harvest — eto_series is
# a daily ET₀ pd.Series (build one with penman_monteith_series on a weather DataFrame)
cwr = crop_water_requirement(eto_series, crop="maize", planting_date=date(2026, 4, 1))

# Soil water balance with auto-irrigation triggers — returns a daily DataFrame
soil    = SoilProperties(field_capacity=0.30, wilting_point=0.15, root_depth=1.0)
balance = SoilWaterBalance(soil).auto_irrigate(
    cwr["etc"], precip_series, efficiency=0.7,
)
print(balance["irrigation_mm"].sum())             # total irrigation applied (mm)
print(int(balance["irrigation_trigger"].sum()))   # number of deficit days

Notebook tutorial: agricultural water demand and irrigation scheduling.

5. AI methodology recommender

from aquascope.ai_engine import DatasetProfile, recommend

# Describe your dataset and goal — get ranked, scored methodologies
profile = DatasetProfile(
    parameters=["DO", "BOD5", "COD"],
    n_records=4_500,
    time_span_years=6.0,
    research_goal="detect long-term pollution trends with seasonality",
)
recs = recommend(profile)

for r in recs[:3]:
    print(f"{r.score:5.1f}  {r.methodology.id:<18}  {r.rationale[:46]}…")
#  55.9  trend_analysis      Your dataset includes bod5, cod, do which are…
#  54.6  lstm_forecasting    Your dataset includes bod5, cod, do which are…
#  54.6  arima_forecast      Your dataset includes bod5, cod, do which are…

Then auto-execute the top result with run_pipeline(recs[0].methodology.id, df).

6. Change-point detection + copula dependence

from aquascope.api import detect_changepoints, fit_copula

cps  = detect_changepoints(annual_runoff, method="pettitt")
cop  = fit_copula(rainfall, runoff, family="auto")    # AIC-selects Gaussian/Clayton/Gumbel/Frank
cp   = cps.changepoints[0]
print(cp.timestamp, cp.p_value)
print(cop.family, cop.parameter, cop.aic)

7. Bayesian regression with uncertainty quantification

from aquascope.api import bayesian_regression

# Annual rainfall → runoff with full posterior + convergence diagnostics
posterior = bayesian_regression(X=annual_precip, y=annual_runoff)

print(posterior.posterior_mean)
# {'beta_0': 12.4, 'beta_1': 0.82, 'sigma2': 41.6}

print(posterior.credible_intervals["beta_1"])
# (0.78, 0.86)        ← 95% credible interval on slope

print(posterior.r_hat)
# {'beta_0': 1.00, 'beta_1': 1.00, 'sigma2': 1.00}    ← Gelman–Rubin, converged

print(posterior.dic, posterior.effective_sample_size["beta_1"])
# 124.7  9842.0       ← model fit + effective sample size

Switch to MCMC with degree>1 for polynomial models, or pass prior_precision for informative priors. Conjugate linear, polynomial, and Metropolis-Hastings backends are all available.


💻 CLI

AquaScope ships a 29-command CLI (agri, basins, caravan, gym and playbooks carry subcommands) for the most common workflows:

# Find stations, then collect data
aquascope stations --bbox -0.5,51.3,0.3,51.7 --variable discharge --format geojson
aquascope harvest stations --out archive          # the open gauge catalog (GeoParquet)
aquascope basins at 48.85 2.35                    # the catchment of any point: area, climate, land cover, soils, dams (BasinATLAS)
aquascope basins similar 25.04 121.56             # gauged basins whose catchments look most like this point's (ungauged-site donors)
aquascope basins regionalize 52.29 -3.51          # estimated flow regime of an ungauged point from those donors, with the leave-one-out skill
aquascope assess 51.415 -0.308 --problem flood_risk   # what can be answered here: gauges in reach, catchment, which methods the record supports
aquascope caravan export --source uk_ea --out caravan_gb   # a Caravan-format large-sample dataset from the archive
aquascope gym run --basin uk_ea/013054a3-670e-49ee-afda-e0865a449197   # HydroGym: calibrate GR4J on a real basin as a gym episode
aquascope mcp                                     # serve the same tools to Claude / Cursor over MCP
aquascope ask "100-year flood of the Seine at Paris?"   # the analyst: tools + a cited Markdown report
aquascope ingest agency_export.csv --unit cfs     # any CSV/Excel -> clean daily series + QA report
aquascope collect --source usgs --days 365
aquascope collect --source wapor --bbox 30.5,29.8,31.1,30.2 --variable RET --start-date 2026-04-01

# Hydrological analysis
aquascope hydro --analysis flood-freq --file discharge.csv
aquascope hydro --analysis baseflow --file discharge.csv --method eckhardt -o baseflow.json

# Agriculture planning
aquascope agri plan --crop maize --planting-date 2026-04-01 --lat 30.0 --lon 31.25 -o plan.csv

# AI recommendation + natural-language problem solving
aquascope recommend --parameters DO,BOD5,COD --goal "pollution trend detection" -o recommendations.json
aquascope solve "Design flow for a road crossing, 100-year return period" --lat 51.415 --lon -0.308
aquascope studio "Design flow for a road crossing, 100-year, and how sure can we be" --lat 51.415 --lon -0.308 --out kingston/   # the crew: brief, plan, run, bundle

# Interactive Streamlit dashboard — multipage workspace with 37 live sources,
# smart auto-insights, and fully interactive Plotly charts
aquascope dashboard

# Shell tab-completion
eval "$(aquascope completion bash)"   # add this to ~/.bashrc (or .zshrc / config.fish)

Run aquascope --help for the full command list.


🌍 Data sources at a glance

37 data collectors spanning five regions (highlights below, full list in the docs):

  • 🌎 Americas — USGS (streamflow + WQ), NOAA NWPS (US streamflow), Colorado DWR/CDSS, Water Quality Portal (400+ agencies), CAMELS-CL (Chile), CAMELS-BR and ANA Hidroweb (Brazil)
  • 🌍 Europe — EU Water Framework Directive, Copernicus ERA5, France Hub'Eau, Germany PEGELONLINE, England's Environment Agency, Ireland OPW, Greece Hydroscope (national archive) and OpenHi.net (live telemetry), Poland IMGW-PIB (daily archive from 1951 and the live network)
  • 🌍 Africa — South Africa DWS (verified discharge and water level)
  • 🌏 Asia-Pacific — Taiwan MOENV / WRA / CWA / Civil IoT / DataGov, Japan MLIT, Korea WAMIS, India WRIS, Australia BOM
  • 🌐 Global — GEMStat (170 countries), UN SDG 6, OpenMeteo, FAO AQUASTAT, FAO WaPOR, GRDC (river discharge)

Full details, endpoints, and API-key requirements: docs/data_sources.md. Want to add your country's water service? See adding a data source.


🧪 Scientifically validated

  • 2,500+ tests — covering every collector, hydrology method, and pipeline (spatial and ARIMA tests require the optional [all] / [ml] extras)
  • CAMELS benchmark — a 10-catchment validation subset of the CAMELS dataset ships with the repo at data/camels_benchmark/ and runs as part of CI
  • Every method cited — equations, decision trees, and DOI references for all 26 methodologies live in the theory guide
  • JOSS paper in preparation — see paper.md and paper.bib

📚 Documentation

Resource What it covers
Features Full capability list — hydrology, agriculture, ML, spatial, I/O
Data sources All 37 sources, endpoints, API-key requirements
Theory guide Equations, DOI citations, decision trees for every method
Methodology matrix When to use which method
Architecture How AquaScope is structured internally
FAQ · Troubleshooting Common questions and fixes
Use cases Real-world applications and case studies
HydroGym A gym-style calibration environment over real basins, with baselines and a leaderboard
HydroGym benchmark Hydrology agents scored on real sites: task outcomes, plan quality against expert plans, and the report the user receives
Integration guides xarray, QGIS, R interoperability
Contributing How to add a data source, methodology, or test

🤝 Contributing

We welcome contributions from the global water and agriculture research community. Highest-impact contributions right now:

  • New data source collectors — your country / region
  • New research methodologies — expand the AI recommender
  • New crop coefficients — extend the FAO Kc table
  • Jupyter tutorials and validation studies — compare against HEC-SSP, R packages, etc.

📌 Where to start

📍 Data sources wanted — help us map every country's water data 🌍 — our pinned meta-issue. Want your country in AquaScope? Start here.

New contributor? These good first issues are scoped with clear acceptance criteria — just comment to claim one:

Area Open issues
🌍 New data collectors Brazil · Canada · South Africa · Australia
🌾 Agriculture Kc for millet/cassava/chickpea · Kc for sorghum/groundnut/sugar beet
📈 Methodologies SPEI drought index · Budyko framework
📊 Visualization interactive Plotly hydrograph · double-mass curve
💻 CLI --output to JSON/CSV · shell completion
📚 Docs & tutorials Colab/Binder badges · groundwater notebook · agri irrigation notebook · translate the docs (zh/fr/ja)
🧪 Code quality & tests type annotations

Browse the full issue list or vote on what to build next in Discussions → Ideas.

See CONTRIBUTING.md, the adding a data source guide, and the adding a methodology guide.

🪜 The contributor ladder

We want contributors to grow, not vanish after one PR. There's a clear path: start with a good first issue, then graduate to a good second issue (a bigger self-contained piece that builds on what you learned), and after a few PRs in one area we'll invite you to help triage and review. See CONTRIBUTORS.md for details.

🙌 Contributors

Thanks to these wonderful people who make AquaScope possible (emoji key):

Abdoul Rachid Ouedraogo
Abdoul Rachid Ouedraogo

💻 📖 🚧
Vaishnavi Desai
Vaishnavi Desai

🔌
Karthick
Karthick

💻
sagiB74
sagiB74

⚠️
Karthik Laishetti
Karthik Laishetti

💻 🐛
Adam Jenkins
Adam Jenkins

🔌 💻 ⚠️
Steven Widjaja
Steven Widjaja

⚠️
Sai Raj Kasam
Sai Raj Kasam

💻
safiashaik04
safiashaik04

💻
Navaneeth Sankar
Navaneeth Sankar

📖 ⚠️
Taran
Taran

💻 ⚠️
Ahmed Baruwa
Ahmed Baruwa

💻 ⚠️
Anthony
Anthony

💻 ⚠️
James Boardman
James Boardman

💻 ⚠️ 📖 🐛
Khyati Tiwari
Khyati Tiwari

💻 🔣
PRAKSHAL BHAVINKUMAR BHANDARI
PRAKSHAL BHAVINKUMAR BHANDARI

📖
Osheun
Osheun

💻 ⚠️ 📖
Dipak Chaudhari
Dipak Chaudhari

💻 ⚠️
Sanchar127
Sanchar127

💻 ⚠️
hari
hari

💻 ⚠️
leatke
leatke

💻 📖 🔬
Talia Pulsifer
Talia Pulsifer

💻 ⚠️
mikemikimike
mikemikimike

💻 ⚠️
Jade
Jade

💻 ⚠️ 🔣
송은우
송은우

💻 ⚠️ 📖
Satya Srujana Pilli
Satya Srujana Pilli

💻 ⚠️
0x
0x

💻
bazinga0027-gif
bazinga0027-gif

💻 ⚠️ 📖

Your first merged PR puts you on this board, every kind of contribution counts. See CONTRIBUTORS.md.

📜 Citation

If you use AquaScope in your research, please cite:

@software{aquascope2026,
  title   = {AquaScope: Open-Source Water Data Aggregation, Hydrological Analysis, and Agricultural Water Management Toolkit},
  author  = {Ouédraogo, Abdoul Rachid},
  year    = {2026},
  url     = {https://github.com/Rekin226/aquascope},
  version = {0.17.0},
  doi     = {10.5281/zenodo.21903143},
  license = {MIT}
}

Machine-readable metadata lives in CITATION.cff; GitHub's "Cite this repository" button renders it in APA and BibTeX. Every tagged release is archived on Zenodo; 10.5281/zenodo.21903143 is the concept DOI that always resolves to the latest version (v0.16.0 is 10.5281/zenodo.22706070).

📄 License

MIT — see LICENSE.

Metadata

Release files for aquascope 0.17.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aquascope 0.17.0
File Size Uploaded
aquascope-0.17.0.tar.gz 7.2 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for aquascope 0.17.0
File Interpreter ABI Platform
aquascope-0.17.0-py3-none-any.whl Python 3 none any Details

Total release size: 8.6 MB

Release files / aquascope-0.17.0.tar.gz

Download URL aquascope-0.17.0.tar.gz
Size 7.2 MB
Tags Source
SHA-256 checksum
How to use checksums
4d3e79f828af8f8fb926a4ac7638b8bf407e83be73e77db8e1bbf3e95a42496c
BLAKE2b-256 checksum
How to use checksums
82224980f336b1a0f3b285decc6356c1208fab2e33c3dfb8de70f73634f2fac7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / aquascope-0.17.0-py3-none-any.whl

Download URL aquascope-0.17.0-py3-none-any.whl
Size 1.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
ed5d995496622966217976065ef73d9fcceae67d1ce4f32ee619ac7dc97d66a6
BLAKE2b-256 checksum
How to use checksums
ce925c6dcbef9f0eac8bf8eb9d98dcb892c64b81cd82a119bbb4ab91bd51c7e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release history Release notifications | RSS feed

0.27.0

2 release files

0.21.0

2 release files

0.20.0

2 release files

0.19.0

2 release files

0.18.0

2 release files

This release

0.17.0 This release

2 release files

0.16.0

2 release files

0.13.0

2 release files

0.12.0

2 release files

0.11.0

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release 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