Ouranosinc / xsdba / 16349269262

79%

Build Type

push

github

Committed by web-flow

Commit Message

Allow additional grouping dimensions to be optional on some methods (#151)

<!-- 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 #99 and fixes #144.
- [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?
In some adjustment methods, the `Grouper`'s `add_dims` are made
optional, i.e. no error is raised if they do not appear on an array.
This enables things like pooling ensemble members in the train : `hist`
has a `"realization"` dim that `ref`does not have.

I was not able to think of a simpler way to implement this, so it's a
bit manual : each time a reducing operation is done, we filter the
`"dim"` variable to remove non-existent dims. The filter is implemented
as a static method of the `Grouper` object as it is expected to be used
in function that we send to `Grouper.apply`. This notably includes
function wrapped by `map_groups`.

I _think_ I found all spots where the filtering was needed, but I'm
pretty confident the tests do not cover all these. I'll try to make some
more tests.

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

Run Details

30 of 31 new or added lines in 2 files covered. (96.77%)

6 existing lines in 4 files now uncovered.

2784 of 3579 relevant lines covered (77.79%)

5.32 hits per line