Rename module xclim.indices to xclim.compute#2330
Draft
aulemahal wants to merge 7 commits into
Draft
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
github-actions
Bot
added
docs
aulemahal
changed the title
xclim.indices to xclim.compute
10 tasks
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
Collaborator
Author
|
We can do the same work division as in the other PR ? The goal here is to go through the documentation and put more emphasis on the indicators, less on the compute function, or at least clarify the difference.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist:
number) and pull request (:pull:number) has been addedWhat kind of change does this PR introduce?
ensemblesandcalendardirectly onimport xclim as xc.Remove(done in [new xclim] Remove legacy sdba stuff #2342)xclim.xsdbaxclim.indicestoxclim.computeFunctions 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.