Ouranosinc / xscen / 39493044775

90%

push

github

Extract vectorized time bounds subsetting to its own function (#786)

<!-- 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] (If applicable) Documentation has been added / updated (for bug
fixes / features).
- [x] (If applicable) Tests have been added.
- [x] This PR does not seem to break the templates.
- [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?
This functionality was in `subset_warming_level`. In PC, I do the
equivalent in two steps : first find all wl periods and later use them
to subset the dataset. The idea being that we can use the periods for
other stuff.

Here, I simply extract it into its own function and generalize it a tiny
bit.

Grosso modo: this is useful when we have an array of start and end years
and want to extract these as a temporal subset of another dataset. It
manages the invalid slices (start or end nan) and works much faster than
doing it with a vectorized `apply_ufunc` on each element (and also
allows chunking along `time` for `ds ).

### Does this PR introduce a breaking change?
No.

### Other information:

32 of 33 new or added lines in 2 files covered. (96.97%)

4515 of 5011 relevant lines covered (90.1%)

9.74 hits per line