Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update generate-percentiles Doc String #1923

Merged
merged 3 commits into from
Aug 3, 2023
Merged

Update generate-percentiles Doc String #1923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2cdab71
Clarifys docstring of generate-percentiles regarding mask_percentiles…
mspelman07 Jul 10, 2023
eb035f2
Updates doc string following review
mspelman07 Jul 26, 2023
3376adc
Merge branch 'master' of github.com:metoppv/improver into doc_string_…
mspelman07 Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions improver/cli/generate_percentiles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,19 @@ def process(
percentile and the ECC bound.
mask_percentiles (bool):
A boolean determining whether the final percentiles should
be masked. This is only implemented to work when converting
probability cubes to percentiles.
be masked. If True then where the percentile is higher than
the probability of the diagnostic existing the outputted
percentile will be masked.
This masking acts to cap the maximum percentile
that can be generated for any grid point relative to the
probability of exceeding the highest threshold at that point.
For example, if the probability of a temperature exceeding 40C
is 5%, the 95th and above percentiles will all be masked.
Likewise, if at some grid point the probability of the cloud base
being below 15000m (the highest threshold) is 70% then every
percentile above the 70th would be masked.
This is only implemented to work when converting probabilities to
percentiles.
optimal_crps_percentiles (bool):
If True, percentiles are computed following the
recommendation of Bröcker, 2012 for optimising the CRPS using
Expand Down
3 changes: 3 additions & 0 deletions improver/ensemble_copula_coupling/ensemble_copula_coupling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,9 @@ def __init__(
The probability of being below the final threshold in
forecast_probabilities is used as the probability of the diagnostic
existing.
For example if at some grid square the probability of cloud base
being below 15000m (the highest threshold) is 0.7 then every percentile
above the 70th would be masked.
skip_ecc_bounds:
If true, the usage of the ECC bounds is skipped. This has the
effect that percentiles outside of the range given by the input
Expand Down