pastas.stats.signatures.cv_period_mean
======================================

.. py:function:: pastas.stats.signatures.cv_period_mean(series: pandas.Series, normalize: bool = False, freq: str = month_offset) -> float

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

   :param series: Pandas Series with DatetimeIndex and head values.
   :type series: pandas.Series
   :param normalize: normalize the time series to values between zero and one.
   :type normalize: bool, optional
   :param freq: frequency to resample the series to by averaging.
   :type freq: str, optional

   :returns: **cv** -- Coefficient of variation of mean head resampled over a period (default monthly).
   :rtype: float

   .. rubric:: Notes

   Coefficient of variation of mean monthly heads, adapted after
   :cite:t:`hughes_hydrological_1989`. The higher the coefficient of variation, the
   more variable the mean monthly head is throughout the year, and vice versa. The
   coefficient of variation is the standard deviation divided by the mean.

   .. rubric:: Examples

   >>> import pandas as pd
   >>> from pastas.stats.signatures import cv_period_mean
   >>> series = pd.Series([1, 2, 3, 4, 5, 6],
                       index=pd.date_range(start='2022-01-01', periods=6, freq='M'))
   >>> cv = cv_period_mean(series)
   >>> print(cv)















   ..
       !! processed by numpydoc !!