Ouranosinc / xclim / 24206295459

92%

main: 92%

Build Type

push

github

Committed by web-flow

Commit Message

[new xclim] Major generics refactor (#2258)

<!--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 #2173
- [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] 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?
Major refactor of the `xclim.indices.generics` submodule.

This new "generic" submodule has harmonized vocabulary and signatures.
Names and words are taken from "clix-meta" when possible.

New submodules:
- `reducers.py ` : for resampling functions like "doymin" and "doymax".
Logic from `to_agg_units` could go here in a further PR.
- `classify.py` : First step for #2192, the MCA-like function we had is
now there.
- `helpers.py` : Not new, but with now an extented reach as to include
tools like `compare` and `spell_mask`

This way, `generic` almost only contains "index-like" function, i.e.
functions ready to be wrapped in a `ResamplingIndicator`.

This PR also introduced `is_temporal_rate` because I needed it to make a
clix index function.

Finally, I reverted the decision from #2150 and now `to_agg_units`
_always_ assumes the input is daily if it can't find its frequency.

### Does this PR introduce a breaking change?
Of course. I'll try to provide a map of the renamed functions tomorrow.

I tried not to break the other `xclim.indices` and `xclim.indicators`
modules. I have not yet measured to full extent of the breaking.


### Suggestion and next steps:
Consider this PR as the first one of a series in preparation of a new
xclim, xclim 1.0 or xclim v2026, depending on how we f... (continued)

Coverage Stats

472 of 518 new or added lines in 22 files covered. (91.12%)

4 existing lines in 3 files now uncovered.

7930 of 8635 relevant lines covered (91.84%)

6.28 hits per line