Ouranosinc / xclim / 34492715312

91%

push

github

Updates to IndicatorCollection (#2415)

<!--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 #2423
- [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?
* Registering an indicator to `xclim.core.indicator.registry` is now
optional
* Indicators created in the context of the Collection from a yaml are
not registered by default.

My goal was to uncouple Collections from the main xclim code. Extra
variables are still shared in `xclim.core.VARIABLES`, but this is less
of an issue I think.

One change this will do is fewer warnings about overwriting indicators
when loading a collection. You know things like:
```
UserWarning: Class conversions.WIND_SPEED_FROM_VECTOR already exists and will be overwritten.
```

EDIT: I added two other changes here:
- Possibility to use python qualified names in the yaml for `base` and
`compute`. Ex: `atmos.precip_accumulation` instead of `prcptot`.
- New `bases` section in the Yaml for indicator _class_ definition, i.e.
base classes to reuse when defining indicators.

### Does this PR introduce a breaking change?
Yes, but easily worked around by passing `register=True` to
`IndicatorCollection.from_yaml`. I'm guessing the registering behaviour
was not used a lot for virtual submodules.

74 of 82 new or added lines in 3 files covered. (90.24%)

7996 of 8824 relevant lines covered (90.62%)

7.64 hits per line