Ouranosinc / xclim
92%

DEFAULT BRANCH: main
Repo Added
Files 60
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH main
branch: SELECT
CHANGE BRANCH
x

coverage: 91.882%. First build
22311596568

push

github

web-flow 
Flexible handling of zero-precipitation probabilities in standardized precipitation index (#2280)

<!--Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [x] This PR addresses an already opened issue (for bug fixes /
features)
    - This PR fixes #2279
- [x] Tests for the changes have been added (for bug fixes / features)
- [x] (If applicable) Documentation has been added / updated (for bug
fixes / features)
- [x] CHANGELOG.rst has been updated (with summary of main changes)
- [x] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added

### What kind of change does this PR introduce?

Adds a new argument `prob_zero_method` to `standardized_index` and
`standardized_precipitation_index`. This argument allows users to
control how the probability of zero-precipitation events ($P(x=0)$) is
handled when transforming to the standard normal distribution.

Supported options are:
* "center" (Default): Uses the Center of Mass method ($P = p_0 / 2$) as
recommended by Stagge et al. (2015) to avoid bias in the mean SPI.
* "upper": Uses the traditional cumulative probability ($P = p_0$),
which replicates the legacy behavior (McKee method).
* Callable: Accepts a custom function (e.g., lambda p: p * 0.75) for
experimental use cases.

### Does this PR introduce a breaking change?

No.

While the default calculation method has changed from the implicit
"upper" method to the unbiased "center" method. The API remains backward
compatible, and users who strictly require the old values can set
prob_zero_method="upper".

24 of 36 new or added lines in 1 file covered. (66.67%)

7934 of 8635 relevant lines covered (91.88%)

6.27 hits per line

Relevant lines Covered
8635 RELEVANT LINES 7934 COVERED LINES
6.27 HITS PER LINE
Source Files on main

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
22311596568 main Flexible handling of zero-precipitation probabilities in standardized precipitation index (#2280) <!--Please ensure the PR fulfills the following requirements! --> <!-- If this is your first PR, make sure to add your details to the AUTHORS.rst! -... push web-flow github
91.88
22115747208 support-socket-blocked Merge d0003e780 into 338bed916 Pull #2324 web-flow github
91.95
22112975037 support-socket-blocked Merge 666ca9af1 into 338bed916 Pull #2324 web-flow github
91.99
22111971788 main Adapt to new xsdba documentation structure (#2325) ### What kind of change does this PR introduce? * Updates the `intersphinx` directives to point at new `xsdba` sphinx targets. * Updates the `ReadTheDocs` configuration to build docs with an old... push web-flow github
92.0
22111670254 update-xsdba-docs Merge 6d74a69f6 into f2b9f0c15 Pull #2325 web-flow github
92.0
22109822234 update-xsdba-docs Merge abf185c9a into f2b9f0c15 Pull #2325 web-flow github
91.97
22109362570 update-xsdba-docs Merge ca26340ff into f2b9f0c15 Pull #2325 web-flow github
91.97
22108500786 update-xsdba-docs Merge ca26340ff into f2b9f0c15 Pull #2325 web-flow github
92.0
22108081135 update-xsdba-docs Merge a1d965e23 into f2b9f0c15 Pull #2325 web-flow github
91.97
22107398076 update-xsdba-docs Merge aaa25ee82 into f2b9f0c15 Pull #2325 web-flow github
92.0
See All Builds (4945)