https://github.com/xiejx5/baseflow
12 baseflow separation methods with automatic parameter calibration
https://github.com/xiejx5/baseflow
baseflow baseflow-separation groundwater hydrology
Last synced: about 2 months ago
JSON representation
12 baseflow separation methods with automatic parameter calibration
- Host: GitHub
- URL: https://github.com/xiejx5/baseflow
- Owner: xiejx5
- Created: 2021-09-20T03:50:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-18T09:04:32.000Z (about 1 year ago)
- Last Synced: 2025-12-16T14:28:45.771Z (5 months ago)
- Topics: baseflow, baseflow-separation, groundwater, hydrology
- Language: Python
- Homepage:
- Size: 320 KB
- Stars: 34
- Watchers: 1
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# baseflow
An open-source Python package for baseflow separation 🔥
## ⚡ Usage
### Install
```bash
pip install baseflow
```
### Example
```python
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](https://github.com/xiejx5/watershed_delineation/releases)
- 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., Jasechko, S., Berghuijs, W. R., Wang, K., Liu, C., Reichstein, M., Jung, M., & Koirala, S. (2024). Majority of global river flow sustained by groundwater. Nature Geoscience, 17(8), 770–777. https://doi.org/10.1038/s41561-024-01483-5
- 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