Skip to main content

A python package for baseflow separation

Project description

baseflow

An open-source Python package for baseflow separation 🔥


Global Baseflow Index Distribution from 12 Separation Methods


⚡  Usage

Install

pip install baseflow

Example

import baseflow
import pandas as pd

df = pd.read_csv(baseflow.example, index_col=0)
df_sta = pd.DataFrame(data=[[30, -28.4, 659], [-109.4, 33, 1611]],
                      index=df.columns, columns=['lon', 'lat', 'area'])
dfs, df_kge = baseflow.separation(df, df_sta, return_kge=True)
print(f'Best Method:\n{df_kge.idxmax(axis=1)}')

Project Structure

The directory structure of baseflow looks like this:

├── methods                 <- implements for 12 baseflow separation 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 baseflow dependencies
│
└── README.md

📌  Todo

Nolinear reservoir assumption

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

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 baseflow separation

🚀  Publications

The following articles detail the baseflow separation methods and their evaluation criterion.

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

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

baseflow-0.0.9.tar.gz (100.7 kB view details)

Uploaded Source

Built Distribution

baseflow-0.0.9-py3-none-any.whl (100.8 kB view details)

Uploaded Python 3

File details

Details for the file baseflow-0.0.9.tar.gz.

File metadata

  • Download URL: baseflow-0.0.9.tar.gz
  • Upload date:
  • Size: 100.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.13

File hashes

Hashes for baseflow-0.0.9.tar.gz
Algorithm Hash digest
SHA256 1f3e29f3a0324f381cbcf021c74b21852b0e848f46e5ade4789d58cbf2db9097
MD5 a72806895b80f5e6eeeb272d2be3384a
BLAKE2b-256 1273021283c775fe7c7d3b4b23df60dc3d2f37fdd3db41f7a0d879f9be3ab144

See more details on using hashes here.

File details

Details for the file baseflow-0.0.9-py3-none-any.whl.

File metadata

  • Download URL: baseflow-0.0.9-py3-none-any.whl
  • Upload date:
  • Size: 100.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.13

File hashes

Hashes for baseflow-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 8e026a4f5a89cd9b448b13850af274bb9e11aac75125cee2cd0c213cd85db753
MD5 32eac8dff003dceb2c7931cf0c473eea
BLAKE2b-256 8a36d0b325cba352b853b29a99374b8085eb651f440fa81c9dda13b110cdbee2

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