signatures
==========

.. py:module:: pastas.stats.signatures

.. autoapi-nested-parse::

   This module contains methods to compute the groundwater signatures. Part of the
   signatures selection is based on the work of :cite:t:`heudorfer_index-based_2019`.

   .. rubric:: Examples

   Compute the coefficient of variation of the mean monthly head::

       cv = ps.stats.cv_period_mean(series)

   ..
       !! processed by numpydoc !!


Functions
---------

.. toctree::
   :hidden:

   /api/pastas/stats/signatures/cv_period_mean
   /api/pastas/stats/signatures/cv_date_min
   /api/pastas/stats/signatures/cv_date_max
   /api/pastas/stats/signatures/parde_seasonality
   /api/pastas/stats/signatures/avg_seasonal_fluctuation
   /api/pastas/stats/signatures/interannual_variation
   /api/pastas/stats/signatures/colwell_constancy
   /api/pastas/stats/signatures/colwell_contingency
   /api/pastas/stats/signatures/low_pulse_count
   /api/pastas/stats/signatures/high_pulse_count
   /api/pastas/stats/signatures/low_pulse_duration
   /api/pastas/stats/signatures/high_pulse_duration
   /api/pastas/stats/signatures/rise_rate
   /api/pastas/stats/signatures/fall_rate
   /api/pastas/stats/signatures/cv_rise_rate
   /api/pastas/stats/signatures/cv_fall_rate
   /api/pastas/stats/signatures/magnitude
   /api/pastas/stats/signatures/reversals_avg
   /api/pastas/stats/signatures/reversals_cv
   /api/pastas/stats/signatures/mean_annual_maximum
   /api/pastas/stats/signatures/bimodality_coefficient
   /api/pastas/stats/signatures/recession_constant
   /api/pastas/stats/signatures/recovery_constant
   /api/pastas/stats/signatures/duration_curve_slope
   /api/pastas/stats/signatures/duration_curve_ratio
   /api/pastas/stats/signatures/richards_pathlength
   /api/pastas/stats/signatures/baselevel_index
   /api/pastas/stats/signatures/baselevel_stability
   /api/pastas/stats/signatures/autocorr_time
   /api/pastas/stats/signatures/date_min
   /api/pastas/stats/signatures/date_max

.. autoapisummary::

   pastas.stats.signatures.cv_period_mean
   pastas.stats.signatures.cv_date_min
   pastas.stats.signatures.cv_date_max
   pastas.stats.signatures.parde_seasonality
   pastas.stats.signatures.avg_seasonal_fluctuation
   pastas.stats.signatures.interannual_variation
   pastas.stats.signatures.colwell_constancy
   pastas.stats.signatures.colwell_contingency
   pastas.stats.signatures.low_pulse_count
   pastas.stats.signatures.high_pulse_count
   pastas.stats.signatures.low_pulse_duration
   pastas.stats.signatures.high_pulse_duration
   pastas.stats.signatures.rise_rate
   pastas.stats.signatures.fall_rate
   pastas.stats.signatures.cv_rise_rate
   pastas.stats.signatures.cv_fall_rate
   pastas.stats.signatures.magnitude
   pastas.stats.signatures.reversals_avg
   pastas.stats.signatures.reversals_cv
   pastas.stats.signatures.mean_annual_maximum
   pastas.stats.signatures.bimodality_coefficient
   pastas.stats.signatures.recession_constant
   pastas.stats.signatures.recovery_constant
   pastas.stats.signatures.duration_curve_slope
   pastas.stats.signatures.duration_curve_ratio
   pastas.stats.signatures.richards_pathlength
   pastas.stats.signatures.baselevel_index
   pastas.stats.signatures.baselevel_stability
   pastas.stats.signatures.autocorr_time
   pastas.stats.signatures.date_min
   pastas.stats.signatures.date_max