Detection, characterisation, clustering and type identification of hydro-sediment events. Only input for detection and clustering is a sub-daily time series data of both streamflow (discharge) and (suspended) sediment concentration. To interpret the identified event clusters into event types, i.e. relating to certain processes or conditions requires expert knowledge and additional data.
The hysevt tool enables event-based analysis of riverine sediment fluxes, by detecting and grouping similar events together, which can in turn be interpreted to understand under which conditions episodic sediment fluxes occur in the target catchment.
A manuscript is in development.
The package no longer requires both python and R for event detection, only to calculate hysteresis indices.
Most of the package is in python. However, the calculation of the hysteresis indices for the event characterisation requires R. Therefore please have the latest version of R installed on your computer. You can download R here.
Install package:
git clone https://gitup.uni-potsdam.de/skalevag2/hysevt.git
cd hysevt
pip install .
Alternatively, the package can be installed in "development" mode. This is useful if you plan to make changes to the module code.
git clone https://gitup.uni-potsdam.de/skalevag2/hysevt.git
cd hysevt
pip install -e .
There are several notebooks demonstrating the use of the package under demo/.
- Event detection using local minima hydrograph separation, and subsequently filtering based on user-defined criteria
- Event characterisation with metrics, based on SSC and Q time series of each event
- Clustering events based on metrics, using GMM or another approach
- Evaluation of metrics clustering
Additionally, there are notebooks showing the use of METS clustering, to identify events (see Javed et al., 2021 for details).
- METS preprocessing: standardising event magnitude and length for the METS cluster alghorithm
- METS clustering: clustering events based on the shape of Mulitvariate Event Time Series
The routines for characterising events can be called from the terminal.
python hysevt/events/metrics.py -g SSC-Q-timeseries.csv -e events.csv -s annual_sediment_yield.csv -q annual_water_yield.csv -o output.csv
Contributions and applications in research is welcome. Please don't hesitate to contact me if you want to use the module in you analysis.
Amalie Skålevåg, [email protected]
GNU General Public License version 3
Currently the R scripts are called from python by calling on the R script in the terminal with csv-files of the timeseries as input. This has only been tested on a Linux operating system. Should you run into problems related to this, a workaround would be to make a copy of the R-script, open this in your preferred IDE, e.g. R-Studio, and running the analysis directly yourself. WARNING: This will only get the hydro events based on the streamflow.
- Manuscript with description and application to an alpine catchment in the European Alps are in development.
- Current version may still have bugs related to versioning and operating systems.
- Event detection has been updated so that it runs completely in python (version 0.3)
- Add new metrics:
- flood duration (streamflow volume to peak ratio) (Qtotal / Qpeak)
- sediment mass to peak ratio as an analog to flood duration? (SSYtotal / SSYpeak)
- Make more of the routines run with terminal commands
- Add tests
- Add more demo-notebooks
- Make event detection more flexible so that different filters can be added or removed according to user's desire
- loadflux R-package
- Sloto, R. A., Crouse, M. Y., & Eaton, G. P. (1996). HYSEP: A Computer Program for Streamflow Hydrograph Separation and Analysis. In Water-Resources Investigations Report. https://doi.org/10.3133/wri964040
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent