pastas.stats.dutch.gvg#

pastas.stats.dutch.gvg(series: pandas.Series, tmin: pandas.Timestamp | str | None = None, tmax: pandas.Timestamp | str | None = None, fill_method: str = 'linear', limit: int = 8, output: str = 'mean', min_n_meas: int = 2, min_n_years: int = 8, year_offset: str = year_offset) → pandas.Series | float#

Calculate the Gemiddelde Voorjaars Grondwaterstand.

GVG is also called MSGL (Mean Spring Groundwater Level).

Parameters:

  • series (pandas.Series with a DatetimeIndex) – The pandas Series of which the statistic is determined.

  • tmin (pandas.Timestamp or str, optional) – A Timestamp or str is expected. The lowest index to take into account (E.g. ‘1980-01-01 00:00:00’). If None, the entire series is used.

  • tmax (pandas.Timestamp or str, optional) – A Timestamp or str is expected. The highest index to take into account (E.g. ‘2020-01-01 00:00:00’). If None, the entire series is used.

  • fill_method (str, optional) – see .. :mod: pastas.stats.dutch._gxg

  • limit (int, optional) – Maximum number of days to fill using fill method. Use 0 to not fill.

  • output (str, optional) – output type * ‘mean’ (default) : for mean of yearly values. * ‘yearly’: for series of yearly values. * ‘g3’: for series with selected data for calculating statistic. * ‘semimonthly’: for series with all data points (14th, 28th of each month).

  • min_n_meas (int, optional) – Minimum number of measurements per year (at maximum 3).

  • min_n_years (int, optional) – Minimum number of years.

  • year_offset (resampling offset. Use "YE" for calendar years) – (jan 1 to dec 31) and “YE-MAR” for hydrological years (apr 1 to mar 31).

Returns:

Series of yearly values or mean of yearly values.

Return type:

pandas.Series or scalar

Notes

Classic method resampling the series to every 14th and 28th of the month. Taking the mean of the values on March 14, March 28 and April 14.