Ouranosinc / xclim / 10205611905
92%

DEFAULT BRANCH: main
Ran
Jobs 0
Files 0
Run time –
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
10205611905

push

github

web-flow 
Generic season index - no season is length 0 (#1845)

<!--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:
- [ ] This PR addresses an already opened issue (for bug fixes /
features)
    - This PR fixes #xyz
- [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?

* Implements `generic.season`, a generic index function for computing
the start/end/length of seasons. Based on `run_length.season` but with
units management and the comparison.
* Divide `run_length.season` into `season_start`, `season_end`, plus the
existing `season_length`. The idea of grouping code together was good,
but it added a lot of unnecessary computations when only one facet is
needed (i.e. most cases). I think I was able to divide it elegantly,
using only one magic fast path.
* Rewrite `frost_free_season_start` and `frost_free_season_end`. Those
were not respecting the "season" definition. Now they do.

### Does this PR introduce a breaking change?
`frost_free_season_start` and `frost_free_season_end` have changed.
Their notion of "season" is not more strict. I think the difference not
significative for most cases. No tests needed a change, but again our
tests are very simple.

All season length indicators will now return 0 when no season is found
(no start). Previously, when no start was found we returned 0 when an
end was found and `nan` otherwise. I think the idea was to assume that
neither end nor start meant the data was probably wrong. But that's the
job of the missing checks, not the `run_length` helper. Thus I a... (continued)
Source Files on build 10205611905
Detailed source file information is not available for this build.