Skip to main content

catchment

An open-source Python package for catchment delineation 🔥


Figure Here


⚡  Usage

Install

pip install catchment

Example

import catchment

path = f'{catchment._path}/example.csv'
Q, date = catchment.load_streamflow(path)
b, KGEs = catchment.delineation(Q, date, area=276)
print(f'Best Method: {b.dtype.names[KGEs.argmax()]}')

Project Structure

The directory structure of catchment looks like this:

├── methods                 <- implements for 12 catchment delineation methods
│
├── recession_analysis      <- tools for estimating recession coefficiency
│
├── param_estimate          <- backward and calibration approaches to estimate other parameters
│
├── comparison              <- an evaluation criterion to comparison different methods
│
├── requirements.txt        <- File for installing catchment dependencies
│
└── README.md

📌  Todo

Nolinear reservoir assumption

  • Implement the nolinear reservoir assumption from the paper
  • Employ a time-varing recession coefficiency for catchment delineation

Applicable to other time scales

  1. The current version only applies to the daily scale
  2. The package needs to be updated to support hourly catchment delineation

🚀  Publications

The following articles detail the 12 catchment delineation methods and their evaluation criterion.

  • Xie, J., Liu, X., Wang, K., Yang, T., Liang, K., & Liu, C. (2020). Evaluation of typical methods for catchment delineation in the contiguous United States. Journal of Hydrology, 583, 124628. https://doi.org/10.1016/j.jhydrol.2020.124628

Metadata

Release files for catchment 0.0.1

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

Source distribution (sdist)

Source distribution for catchment 0.0.1
File Size Uploaded
catchment-0.0.1.tar.gz 3.8 kB Details

Built distribution (wheel)

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

Total release size: 6.2 kB

Release files / catchment-0.0.1.tar.gz

Download URL catchment-0.0.1.tar.gz
Size 3.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1b3e4712d5068159213eeabdacd5634d1dfa8fcc8f15615ba4ef8ec8ac3efb0a
BLAKE2b-256 checksum
How to use checksums
443f053cc611ad90a60d5693fecc8639d069f0d1b2c0a7c8f00ca9bda570143a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

Release files / catchment-0.0.1-py3-none-any.whl

Download URL catchment-0.0.1-py3-none-any.whl
Size 2.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
edf960259b017bedd62d417b3c31691af0ac9aef343b7a4ec4986a6f93722673
BLAKE2b-256 checksum
How to use checksums
67d72788d1be27f31a87388753eba98625f453cb72bfd0b1b7779f440c58342a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

Release history Release notifications | RSS feed

This release

0.0.1 This release

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