Ouranosinc / xsdba / 13576717294

79%

Build Type

push

github

Committed by web-flow

Commit Message

MBCn with 5days-OddWindow (#79)

<!-- 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] 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?

* Small workaround to be able to use the 5 day grouping in MBCn,
compatible with odd windows.

### Does this PR introduce a breaking change?

No

### Other information:

This doesn't respect the logic of `Grouper`, but to activate this
functionality, I pass a `Grouper("5D", window=7)`. I think only time,
time.season, time.month, time.dayofyear would be allowed as strings in a
proper implementation ("The usual grouping name as xarray understands
it. Ex: "time.month" or "time".") To allow more complex group, I guess
we would need to accept Pandas object or something.

Since MBCn doesn't currently use map_groups, implementing this hack was
relatively easy.

This is also thought specifically for a 365-day calendar, that 5 is a
factor of 365 (5*73).

Run Details

2 of 14 new or added lines in 3 files covered. (14.29%)

2 existing lines in 1 file now uncovered.

2405 of 3264 relevant lines covered (73.68%)

4.42 hits per line