Skip to content

Commit

Permalink
Docstring updates in gaussian_plume.py.
Browse files Browse the repository at this point in the history
  • Loading branch information
mattj89 committed Jul 2, 2024
1 parent 3ca9e6c commit 0f5e24b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/pyelq/dispersion_model/gaussian_plume.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 0f5e24b

Please sign in to comment.