Ouranosinc / xclim / 7213677675

90%

main: 92%

push

github

Add Lafferty and Sriver partition (#1529)

<!--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 #1497 
- [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] CHANGES.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?

*  Add partition algo from Lafferty and Sriver (2023)

### Does this PR introduce a breaking change?
depends (see options below)

### Other information:
TODO list in this PR:

- [x] Add weights
- [x] add tests
- [x] Maybe add `num` to `hawkins_sutton` ?
- [x] Clean up based on changes outside of this PR (eg. remove functions
that are now elsewhere)

TODO list outside of this PR:

- [ ] Add a more general `graph_fraction_of_total_variance` to figanos
(in progress by Juliette,
https://github.com/Ouranosinc/figanos/pull/134)
- [ ] Add a function in xscen to prepare the data from a catalog.
(https://github.com/Ouranosinc/xscen/pull/289)

In this function, I could rename the dimension to fit what the partition
vocabulary (`model`, `scenario`, `downscaling`) OR we could change the
partition vocab to the catalog/xscen vocab (`source`, `experiment`,
`bias_adjust_project`). Option 2 is my personal preference, but that
would be a breaking change for `hawkins_sutton`.

29 of 32 new or added lines in 2 files covered. (90.63%)

8587 of 9494 relevant lines covered (90.45%)

4.37 hits per line