Ouranosinc / xscen / 16626193669

90%

push

github

Fixed spatial_mean always using spatialAverager's default dimension name (#620)

<!-- 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
- [ ] (If applicable) Documentation has been added / updated (for bug
fixes / features).
- [ ] (If applicable) Tests have been added.
- [x] This PR does not seem to break the templates.
- [ ] CHANGELOG.rst has been updated (with summary of main changes).
- [ ] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added.

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

Fix:
[xscen.spatial_mean](https://github.com/Ouranosinc/xscen/blob/main/src/xscen/aggregate.py#L636)
now reuses the custom dimension name "geom_dim_name" provided via
"kwargs" to
[xesmf.spatialAverager](https://github.com/pangeo-data/xESMF/blob/master/xesmf/frontend.py#L1123),
defaulting back to "geom" when not specified.

This is needed because the current implementation of xscen.spatial_mean
always outputs a dataset with dimension "geom". As such, if someone
passes:
`kwargs = {"geom_dim_name": "region"}`
The output dataset will have both "geom" and "region" dimensions.

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

### Other information:

3 of 3 new or added lines in 1 file covered. (100.0%)

4043 of 4593 relevant lines covered (88.03%)

6.07 hits per line