signatures#

This module contains methods to compute the groundwater signatures. Part of the signatures selection is based on the work of Heudorfer et al. [2019].

Examples

Compute the coefficient of variation of the mean monthly head:

cv = ps.stats.cv_period_mean(series)

Functions#

cv_period_mean(→ float)

Coefficient of variation of the mean head over a period (default monthly).

cv_date_min(→ float)

Coefficient of variation of the date of annual minimum head.

cv_date_max(→ float)

Coefficient of variation of the date of annual maximum head.

parde_seasonality(→ float)

Parde seasonality according to Pardé [1933], adapted for heads.

avg_seasonal_fluctuation(→ float)

Average seasonal fluctuation after Martens et al. [2013].

interannual_variation(→ float)

Interannual variation after Martens et al. [2013].

colwell_constancy(→ tuple[float, float, float])

Colwells constancy index after Colwell [1974].

colwell_contingency(→ tuple[float, float, float])

Colwell's contingency Colwell [1974]

low_pulse_count(→ float)

Average number of times the series is below a certain threshold per year.

high_pulse_count(→ float)

Average number of times the series exceeds a certain threshold per year.

low_pulse_duration(→ float)

Average duration of pulses where the head is below a certain threshold.

high_pulse_duration(→ float)

Average duration of pulses where the head exceeds a certain threshold.

rise_rate(→ float)

Mean of positive head changes from one day to the next.

fall_rate(→ float)

Mean negative head changes from one day to the next.

cv_rise_rate(→ float)

Coefficient of Variation in rise rate.

cv_fall_rate(→ float)

Coefficient of Variation in fall rate.

magnitude(→ float)

Difference between the minimum and maximum heads, divided by the minimum head

reversals_avg(→ float)

Average annual number of rises and falls in daily head.

reversals_cv(→ float)

Coefficient of Variation in annual number of rises and falls.

mean_annual_maximum(→ float)

Mean of annual maximum head after Clausen and Biggs [2000].

bimodality_coefficient(→ float)

Bimodality coefficient after Ellison [1987].

recession_constant(→ float)

Recession constant adapted after Kirchner [2009].

recovery_constant(→ float)

Recovery constant after Kirchner [2009].

duration_curve_slope(→ float)

Slope of the head duration curve between percentile l and u after

duration_curve_ratio(→ float)

Ratio of the head duration curve between the percentile l and u after

richards_pathlength(→ float)

The path length of the time series, standardized by time series length after

baselevel_index(→ float)

Base level index (BLI) adapted after Organization [2008].

baselevel_stability(→ float)

Baselevel stability after Heudorfer et al. [2019].

autocorr_time(→ float)

Lag where the autocorrelation function exceeds a cut-off value.

date_min(→ float)

Compute the average date of the minimum head value with circular statistics.

date_max(→ float)

Compute the average date of the maximum head value with circular statistics.