Skip to content

Rename module xclim.indices to xclim.compute#2330

Draft
aulemahal wants to merge 2 commits intodev-v099from
refactor-v1
Draft

Rename module xclim.indices to xclim.compute#2330
aulemahal wants to merge 2 commits intodev-v099from
refactor-v1

Conversation

@aulemahal
Copy link
Collaborator

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
  • Tests for the changes have been added (for bug fixes / features)
    • (If applicable) Documentation has been added / updated (for bug fixes / features)
  • 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
  • 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.

@aulemahal aulemahal added the xclim-v1 First major release of xclim label Mar 6, 2026
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions github-actions bot added docs Improvements to documenation indicators Climate indices and indicators labels Mar 6, 2026
@aulemahal aulemahal changed the title indices to compute - rm xsdba - expose ensemble calendar Rename module xclim.indices to xclim.compute Mar 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements to documenation indicators Climate indices and indicators xclim-v1 First major release of xclim

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant