From 0f5e24ba8c3328e0551a5890d475d16baa6cf1e6 Mon Sep 17 00:00:00 2001 From: "Matthew.Jones" Date: Tue, 2 Jul 2024 11:25:09 +0200 Subject: [PATCH] Docstring updates in gaussian_plume.py. --- src/pyelq/dispersion_model/gaussian_plume.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pyelq/dispersion_model/gaussian_plume.py b/src/pyelq/dispersion_model/gaussian_plume.py index 46b8683..e476a27 100644 --- a/src/pyelq/dispersion_model/gaussian_plume.py +++ b/src/pyelq/dispersion_model/gaussian_plume.py @@ -575,9 +575,9 @@ def compute_coverage( Args: couplings (np.ndarray): Array of coupling values. Dimensions: n_datapoints x n_sources. threshold_function (Callable): Callable function which returns some single value that defines the - maximum or 'threshold' coupling. + maximum or 'threshold' coupling. For example: np.quantile(., q=0.95) coverage_threshold (float, optional): The threshold value of the estimated emission rate which is - considered to be within the coverage. Defaults to 6 kg/hr. + considered to be within the coverage. Defaults to 6 kg/hr. kwargs (dict, optional): Keyword arguments required for the threshold function. Returns: