Skip to content

Commit

Permalink
Formatted & updated docstring for threshold_function.
Browse files Browse the repository at this point in the history
  • Loading branch information
mattj89 committed Jul 2, 2024
1 parent 61283bd commit 2b1fb4c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/pyelq/component/source_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""

Expand Down

0 comments on commit 2b1fb4c

Please sign in to comment.