Refactor 'region' - Githubissues

Ouranosinc / xscen

A climate change scenario-building analysis framework.

https://xscen.readthedocs.io/

Apache License 2.0

17 stars 2 forks source link

Refactor 'region' #184

Closed RondeauG closed 1 year ago

RondeauG commented 1 year ago

Pull Request Checklist:

[x] This PR addresses an already opened issue (for bug fixes / features)
- This PR fixes #99
- This PR fixes #101
[x] (If applicable) Documentation has been added / updated (for bug fixes / features)
[x] This PR does not seem to break the templates.
[x] HISTORY.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?

Refactors region to make it more easily understandable and make use of **kwargs instead of the awkward formatting that it currently has.
Makes the arguments of xs.spatial.subset more explicit. region is still used in xs.extract_dataset and xs.spatial_mean, but not in xs.spatial.subset.

Does this PR introduce a breaking change?

Multiple things get deprecated due to the changes in formatting, but everything should still be supported for the time being.

Other information: