From 2b1fb4cab9c3abe3d4756823cffe3912d182d5ec Mon Sep 17 00:00:00 2001 From: "Matthew.Jones" Date: Tue, 2 Jul 2024 09:34:31 +0200 Subject: [PATCH] Formatted & updated docstring for threshold_function. --- src/pyelq/component/source_model.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/pyelq/component/source_model.py b/src/pyelq/component/source_model.py index 1defaf9..ad19a97 100644 --- a/src/pyelq/component/source_model.py +++ b/src/pyelq/component/source_model.py @@ -448,9 +448,9 @@ class SourceModel(Component, SourceGrouping, SourceDistribution): coverage_detection (float): sensor detection threshold (in ppm) to be used for coverage calculations. coverage_test_source (float): test source (in kg/hr) which we wish to be able to see in coverage calculation. - threshold_function (Callable): Callable function which returns some single value that defines the - threshold' coupling in a lambda function form. Examples: lambda x: np.quantile(x, 0.95, axis=0), - lambda x: np.max(x, axis=0), lambda x: np.mean(x, axis=0). Defaults to np.max. Defaults to np.quantile. + threshold_function (Callable): Callable function which returns a single value that defines the threshold + for the coupling in a lambda function form. Examples: lambda x: np.quantile(x, 0.95, axis=0), + lambda x: np.max(x, axis=0), lambda x: np.mean(x, axis=0). Defaults to np.quantile. """