HydroSwift ⚡

Fast, unified workflows for hydrological data.

HydroSwift automates retrieval, processing, and visualization of hydrological observations from India-WRIS and the CWC Flood Forecasting System. It supports discharge, water level, rainfall, temperature, humidity, solar radiation, sediment, groundwater, and atmospheric pressure datasets.

---

Installation

git clone https://github.com/carbform/HydroSwift.git
cd swift
pip install -e .          # core
pip install -e .[all]     # with plotting + geospatial extras

Verify:

hyswift --version

---

Quick Start

Python API

import hydroswift

# Discover → download → merge in one step
stations = hydroswift.wris.stations(basin="Godavari", variable="discharge")
hydroswift.fetch(stations, start_date="2024-01-01", end_date="2024-03-31", merge=True)

# Or download directly when you already know the inputs
hydroswift.cwc.download(station=["040-CDJAPR", "032-LGDHYD"], merge=True)

CLI

hyswift -b Godavari -q --merge                          # WRIS discharge
hyswift -b Krishna -q -rf -temp                         # multiple variables
hyswift --cwc-basin Krishna Godavari                    # CWC water level
hyswift --plot-only --input-dir output --plot-svg       # generate plots

---

Documentation

Full docs are available at hydroswift.readthedocs.io, including:

• Python API Guide
• CLI Usage Guide
• API Functions Reference
• Example Notebooks

---

Output Structure

output/
  wris/<basin>/<variable>/*.csv
  wris/<basin>/*.gpkg
  cwc/<basin>/stations/*.csv
  cwc/cwc_waterlevel*.gpkg

---

Data Sources

• India Water Resources Information System (WRIS)
• Central Water Commission (CWC) Flood Forecasting System

License

MIT License — see LICENSE for details.

Acknowledgements

Built with pandas, geopandas, matplotlib, and requests.