From 1d016aef9bfd9c2549730702e8518f2f737c2b05 Mon Sep 17 00:00:00 2001 From: casadoj Date: Fri, 4 Oct 2024 15:46:48 +0200 Subject: [PATCH] Update thresholds --- src/lisfloodutilities/thresholds/thresholds.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/lisfloodutilities/thresholds/thresholds.py b/src/lisfloodutilities/thresholds/thresholds.py index 50f8974..fab4f6f 100755 --- a/src/lisfloodutilities/thresholds/thresholds.py +++ b/src/lisfloodutilities/thresholds/thresholds.py @@ -16,7 +16,7 @@ import numpy as np import xarray as xr -from typing import Tuple +from typing import Tuple, Union def lmoments(values: np.ndarray) -> np.ndarray: @@ -128,7 +128,7 @@ def gumbel_function( sigma: Union[np.ndarray, float], mu: Union[np.ndarray, float] ) -> Union[np.ndarray, float]: - """Compute the value of a Gumbel distribution associated to a return periods. + """Compute the value of a Gumbel distribution associated to certain return periods. This function is equivalent to scipy.stats.gumbel_r.ppf(1 - 1 / return_period, loc=mu, scale=sigma)