Ouranosinc / xclim / 31811554733

91%

main: 91%

push

github

Rename module `xclim.indices` to `xclim.compute` (#2330)

<!--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 #2320
- [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)
- [ ] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added

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

* Expose `ensembles` and `calendar` directly on `import xclim as xc`. 
* ~Remove `xclim.xsdba`~ (done in #2342)
* But mostly : rename `xclim.indices` to `xclim.compute`

Functions previously called "indices" are now called "compute
functions", with the additional qualifier "index-like" when needed. I
tried to remove the word "indices" as much as possible, but preserved it
when it actually meant the plural of "index" (like for SPI-like things)
or when the usage comes from an external source (ex: "fire weather
indices", "icclim indices").

### Does this PR introduce a breaking change?
You bet it does!

### Other information:
This must come with a major revision of the documentation, I might
delete duplicate/useless notebooks. But I'll try to limit the changes to
the subject here : indices vs indicators. Other documentation
reorganisation/revision for v1 is to be done elsewhere.

103 of 107 new or added lines in 35 files covered. (96.26%)

7918 of 8733 relevant lines covered (90.67%)

7.64 hits per line