xclim

A library of derived climate variables, i.e. climate indicators, based on xarray.
https://github.com/ouranosinc/xclim

Category: Climate Change
Sub Category: Climate Data Processing and Analysis

Keywords

anuclim climate-analysis climate-science dask icclim netcdf4 python xarray xclim

Keywords from Contributors

climate archiving wps hydrology ogc indices birdhouse observability earth-system-model pavics

Last synced: about 17 hours ago
JSON representation

Repository metadata

Library of derived climate variables, ie climate indicators, based on xarray.

• Host: GitHub
• URL: https://github.com/ouranosinc/xclim
• Owner: Ouranosinc
• License: apache-2.0
• Created: 2018-07-27T18:02:20.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2025-04-21T13:36:12.000Z (6 days ago)
• Last Synced: 2025-04-22T07:03:32.277Z (5 days ago)
• Topics: anuclim, climate-analysis, climate-science, dask, icclim, netcdf4, python, xarray, xclim
• Language: Python
• Homepage: https://xclim.readthedocs.io/en/stable/
• Size: 60.3 MB
• Stars: 354
• Watchers: 15
• Forks: 65
• Open Issues: 59
• Releases: 83
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff
  • Security: SECURITY.md
  • Support: docs/support.rst
  • Authors: AUTHORS.rst
  • Zenodo: .zenodo.json

README.rst

          ===============================================================
xclim: Climate services library |logo| |logo-dark| |logo-light|
===============================================================

+----------------------------+-----------------------------------------------------+
| Versions                   | |pypi| |conda| |versions|                           |
+----------------------------+-----------------------------------------------------+
| Documentation and Support  | |docs| |discussions|                                |
+----------------------------+-----------------------------------------------------+
| Open Source                | |license| |ossf-score| |zenodo| |pyOpenSci| |joss|  |
+----------------------------+-----------------------------------------------------+
| Coding Standards           | |ruff| |pre-commit| |ossf-bp| |fossa|               |
+----------------------------+-----------------------------------------------------+
| Development Status         | |status| |build| |coveralls|                        |
+----------------------------+-----------------------------------------------------+

`xclim` is an operational Python library for climate services, providing numerous climate-related indicator tools
with an extensible framework for constructing custom climate indicators, statistical downscaling and bias
adjustment of climate model simulations, as well as climate model ensemble analysis tools.

`xclim` is built using `xarray`_ and can seamlessly benefit from the parallelization handling provided by `dask`_.
Its objective is to make it as simple as possible for users to perform typical climate services data treatment workflows.
Leveraging `xarray` and `dask`, users can easily bias-adjust climate simulations over large spatial domains or compute indices from large climate datasets.

For example, the following would compute monthly mean temperature from daily mean temperature:

.. code-block:: python

    import xclim
    import xarray as xr

    ds = xr.open_dataset(filename)
    tg = xclim.atmos.tg_mean(ds.tas, freq="MS")

For applications where metadata and missing values are important to get right, `xclim` provides a class for each index
that validates inputs, checks for missing values, converts units and assigns metadata attributes to the output.
This also provides a mechanism for users to customize the indices to their own specifications and preferences.
`xclim` currently provides over 150 indices related to mean, minimum and maximum daily temperature, daily precipitation,
streamflow and sea ice concentration, numerous bias-adjustment algorithms, as well as a dedicated module for ensemble analysis.

.. _xarray: https://docs.xarray.dev/
.. _dask: https://docs.dask.org/

Quick Install
-------------
`xclim` can be installed from PyPI:

.. code-block:: shell

    $ pip install xclim

or from Anaconda (conda-forge):

.. code-block:: shell

    $ conda install -c conda-forge xclim

Documentation
-------------
The official documentation is at https://xclim.readthedocs.io/

How to make the most of xclim: `Basic Usage Examples`_ and `In-Depth Examples`_.

.. _Basic Usage Examples: https://xclim.readthedocs.io/en/stable/notebooks/usage.html
.. _In-Depth Examples: https://xclim.readthedocs.io/en/stable/notebooks/index.html

Conventions
-----------
In order to provide a coherent interface, `xclim` tries to follow different sets of conventions. In particular, input data should follow the `CF conventions`_ whenever possible for variable attributes. Variable names are usually the ones used in `CMIP6`_, when they exist.

However, `xclim` will *always* assume the temporal coordinate is named "time". If your data uses another name (for example: "T"), you can rename the variable with:

.. code-block:: python

    ds = ds.rename(T="time")

`xclim` employs `black`_-like code formatting style, a modified `ruff`_ linting configuration, and (mostly) adheres to the `NumPy docstring`_ style. For more information on coding and development conventions, see the `Contributing Guidelines`_.

.. _black: https://black.readthedocs.io/en/stable/
.. _ruff: https://docs.astral.sh/ruff/
.. _CF Conventions: http://cfconventions.org/
.. _CMIP6: https://clipc-services.ceda.ac.uk/dreq/mipVars.html
.. _NumPy docstring: https://numpydoc.readthedocs.io/en/stable/format.html

Contributing to xclim
---------------------
`xclim` is in active development and is being used in production by climate services specialists around the world.

* If you're interested in participating in the development of `xclim` by suggesting new features, new indices or report bugs, please leave us a message on the `issue tracker`_.
    * If you have a support/usage question or would like to translate `xclim` to a new language, be sure to check out the existing |discussions| first!

* If you would like to contribute code or documentation (which is greatly appreciated!), check out the `Contributing Guidelines`_ before you begin!

.. _issue tracker: https://github.com/Ouranosinc/xclim/issues
.. _Contributing Guidelines: https://github.com/Ouranosinc/xclim/blob/main/CONTRIBUTING.rst

How to cite this library
------------------------
If you wish to cite `xclim` in a research publication, we kindly ask that you refer to our article published in The Journal of Open Source Software (`JOSS`_): https://doi.org/10.21105/joss.05415

To cite a specific version of `xclim`, the bibliographical reference information can be found through `Zenodo`_

.. _JOSS: https://joss.theoj.org/
.. _Zenodo: https://doi.org/10.5281/zenodo.2795043

License
-------
This is free software: you can redistribute it and/or modify it under the terms of the `Apache License 2.0`_. A copy of this license is provided in the code repository (`LICENSE`_).

.. _Apache License 2.0: https://opensource.org/license/apache-2-0/
.. _LICENSE: https://github.com/Ouranosinc/xclim/blob/main/LICENSE

Energy and Carbon Usage
-----------------------
The `xclim` development team is interested in thoroughly testing our software while also reducing the environmental impact of the software we develop.
This repository uses the `ECO-CI`_ tool to estimate and track the energy use and carbon emissions of our continuous integration workflows.

+---------------------------------------------------------------------------------------+
| `ECO-CI`_ Energy Use and Carbon Emissions from CI Workflows (since November 2024)     |
+------------------+------------------+-------------------------------------------------+
| Testing suite    | Energy Usage     | |energy-last| |energy-average| |energy-total|   |
|                  +------------------+-------------------------------------------------+
| (*main* branch)  | Carbon Emissions | |carbon-last| |carbon-average| |carbon-total|   |
+------------------+------------------+-------------------------------------------------+

Credits
-------
`xclim` development is funded through Ouranos_, Environment and Climate Change Canada (ECCC_), the `Fonds vert`_ and the Fonds d'électrification et de changements climatiques (FECC_), the Canadian Foundation for Innovation (CFI_), and the Fonds de recherche du Québec (FRQ_).

This package was created with Cookiecutter_ and the `audreyfeldroy/cookiecutter-pypackage`_ project template.

.. _audreyfeldroy/cookiecutter-pypackage: https://github.com/audreyfeldroy/cookiecutter-pypackage/
.. _CFI: https://www.innovation.ca/
.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter/
.. _ECCC: https://www.canada.ca/en/environment-climate-change.html
.. _ECO-CI: https://www.green-coding.io/
.. _FECC: https://www.environnement.gouv.qc.ca/ministere/fonds-electrification-changements-climatiques/index.htm
.. _Fonds vert: https://www.environnement.gouv.qc.ca/ministere/fonds-vert/index.htm
.. _FRQ: https://frq.gouv.qc.ca/
.. _Ouranos: https://www.ouranos.ca/

.. |pypi| image:: https://img.shields.io/pypi/v/xclim.svg
        :target: https://pypi.python.org/pypi/xclim
        :alt: Python Package Index Build

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/xclim.svg
        :target: https://anaconda.org/conda-forge/xclim
        :alt: Conda-forge Build Version

.. |discussions| image:: https://img.shields.io/badge/GitHub-Discussions-blue
        :target: https://github.com/Ouranosinc/xclim/discussions
        :alt: Static Badge

.. |build| image:: https://github.com/Ouranosinc/xclim/actions/workflows/main.yml/badge.svg
        :target: https://github.com/Ouranosinc/xclim/actions/workflows/main.yml
        :alt: Build Status

.. |coveralls| image:: https://coveralls.io/repos/github/Ouranosinc/xclim/badge.svg
        :target: https://coveralls.io/github/Ouranosinc/xclim
        :alt: Coveralls

.. |docs| image:: https://readthedocs.org/projects/xclim/badge
        :target: https://xclim.readthedocs.io/en/latest
        :alt: Documentation Status

.. |zenodo| image:: https://zenodo.org/badge/142608764.svg
        :target: https://zenodo.org/badge/latestdoi/142608764
        :alt: DOI

.. |pyOpenSci| image:: https://tinyurl.com/y22nb8up
        :target: https://github.com/pyOpenSci/software-review/issues/73
        :alt: pyOpenSci

.. |joss| image:: https://joss.theoj.org/papers/10.21105/joss.05415/status.svg
        :target: https://doi.org/10.21105/joss.05415
        :alt: JOSS

.. |license| image:: https://img.shields.io/github/license/Ouranosinc/xclim.svg
        :target: https://github.com/Ouranosinc/xclim/blob/main/LICENSE
        :alt: License

.. |ossf-bp| image:: https://bestpractices.coreinfrastructure.org/projects/6041/badge
        :target: https://bestpractices.coreinfrastructure.org/projects/6041
        :alt: Open Source Security Foundation Best Practices

.. |ossf-score| image:: https://api.securityscorecards.dev/projects/github.com/Ouranosinc/xclim/badge
        :target: https://securityscorecards.dev/viewer/?uri=github.com/Ouranosinc/xclim
        :alt: Open Source Security Foundation Scorecard

.. |fossa| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2FOuranosinc%2Fxclim.svg?type=shield
        :target: https://app.fossa.com/projects/git%2Bgithub.com%2FOuranosinc%2Fxclim?ref=badge_shield
        :alt: FOSSA

.. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/xclim/main/docs/logos/xclim-logo-small-light.png
        :target: https://github.com/Ouranosinc/xclim
        :alt: Xclim
        :class: xclim-logo-small no-theme

.. |logo-light| image:: https://raw.githubusercontent.com/Ouranosinc/xclim/main/docs/logos/empty.png
        :target: https://github.com/Ouranosinc/xclim
        :alt:
        :class: xclim-logo-small only-light-inline

.. |logo-dark| image:: https://raw.githubusercontent.com/Ouranosinc/xclim/main/docs/logos/empty.png
        :target: https://github.com/Ouranosinc/xclim
        :alt:
        :class: xclim-logo-small only-dark-inline

.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/Ouranosinc/xclim/main.svg
        :target: https://results.pre-commit.ci/latest/github/Ouranosinc/xclim/main
        :alt: pre-commit.ci status

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
        :target: https://github.com/astral-sh/ruff
        :alt: Ruff

.. |status| image:: https://www.repostatus.org/badges/latest/active.svg
        :target: https://www.repostatus.org/#active
        :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.

.. |versions| image:: https://img.shields.io/pypi/pyversions/xclim.svg
        :target: https://pypi.python.org/pypi/xclim
        :alt: Supported Python Versions

..
    Energy Metrics by https://github.com/green-coding-solutions/eco-ci-energy-estimation

.. |energy-total| image:: https://api.green-coding.io/v1/ci/badge/get?repo=Ouranosinc/xclim&branch=main&workflow=5828641&mode=totals
        :target: https://metrics.green-coding.io/ci.html?repo=Ouranosinc/xclim&branch=main&workflow=5828641
        :alt: Energy Consumption (Total)

.. |energy-last| image:: https://api.green-coding.io/v1/ci/badge/get?repo=Ouranosinc/xclim&branch=main&workflow=5828641
        :target: https://metrics.green-coding.io/ci.html?repo=Ouranosinc/xclim&branch=main&workflow=5828641
        :alt: Energy Consumption (Last run)

.. |energy-average| image:: https://api.green-coding.io/v1/ci/badge/get?repo=Ouranosinc/xclim&branch=main&workflow=5828641&mode=avg&duration_days=90
        :target: https://metrics.green-coding.io/ci.html?repo=Ouranosinc/xclim&branch=main&workflow=5828641
        :alt: Energy Consumption (Last 90 days moving average)

.. |carbon-total| image:: https://api.green-coding.io/v1/ci/badge/get?repo=Ouranosinc/xclim&branch=main&workflow=5828641&mode=totals&metric=carbon
        :target: https://metrics.green-coding.io/ci.html?repo=Ouranosinc/xclim&branch=festive-indices&workflow=5828641
        :alt: Carbon Emissions (Total)

.. |carbon-last| image:: https://api.green-coding.io/v1/ci/badge/get?repo=Ouranosinc/xclim&branch=main&workflow=5828641&metric=carbon
        :target: https://metrics.green-coding.io/ci.html?repo=Ouranosinc/xclim&branch=main&workflow=5828641
        :alt: Carbon Emissions (Last run)

.. |carbon-average| image:: https://api.green-coding.io/v1/ci/badge/get?repo=Ouranosinc/xclim&branch=main&workflow=5828641&mode=avg&duration_days=90&metric=carbon
        :target: https://metrics.green-coding.io/ci.html?repo=Ouranosinc/xclim&branch=main&workflow=5828641
        :alt: Carbon Emissions (Last 90 days moving average)

        

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Bourgault
  given-names: Pascal
  orcid: "https://orcid.org/0000-0003-1192-0403"
- family-names: Huard
  given-names: David
  orcid: "https://orcid.org/0000-0003-0311-5498"
- family-names: Smith
  given-names: Trevor James
  orcid: "https://orcid.org/0000-0001-5393-8359"
- family-names: Logan
  given-names: Travis
  orcid: "https://orcid.org/0000-0002-2212-9580"
- family-names: Aoun
  given-names: Abel
  orcid: "https://orcid.org/0000-0003-2289-2890"
- family-names: Lavoie
  given-names: Juliette
  orcid: "https://orcid.org/0000-0002-4708-5182"
- family-names: Dupuis
  given-names: Éric
  orcid: "https://orcid.org/0000-0001-7976-4596"
- family-names: Rondeau-Genesse
  given-names: Gabriel
  orcid: "https://orcid.org/0000-0003-3389-9406"
- family-names: Alegre
  given-names: Raquel
  orcid: "https://orcid.org/0000-0002-6081-0721"
- family-names: Barnes
  given-names: Clair
  orcid: "https://orcid.org/0000-0002-7806-7913"
- family-names: Laperrière
  given-names: Alexis Beaupré
- family-names: Biner
  given-names: Sébastien
  orcid: "https://orcid.org/0000-0001-7515-490X"
- family-names: Caron
  given-names: David
- family-names: Ehbrecht
  given-names: Carsten
- family-names: Fyke
  given-names: Jeremy
  orcid: "https://orcid.org/0000-0002-4522-3019"
- family-names: Keel
  given-names: Tom
  orcid: "https://orcid.org/0000-0001-9193-5271"
- family-names: Labonté
  given-names: Marie-Pier
  orcid: "https://orcid.org/0000-0003-0738-3940"
- family-names: Lierhammer
  given-names: Ludwig
  orcid: "https://orcid.org/0000-0002-7207-0003"
- family-names: Low
  given-names: Jwen-Fai
  orcid: "https://orcid.org/0000-0001-6618-7443"
- family-names: Quinn
  given-names: Jamie
- family-names: Roy
  given-names: Philippe
  orcid: "https://orcid.org/0000-0003-1239-7589"
- family-names: Squire
  given-names: Dougie
  orcid: "https://orcid.org/0000-0003-3271-6874"
- family-names: Stephens
  given-names: Ag
  orcid: "https://orcid.org/0000-0002-1038-7988"
- family-names: Tanguy
  given-names: Maliko
  orcid: "https://orcid.org/0000-0002-1516-6834"
- family-names: Whelan
  given-names: Christopher
contact:
- family-names: Logan
  given-names: Travis
  orcid: "https://orcid.org/0000-0002-2212-9580"
doi: 10.5281/zenodo.7916446
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Bourgault
    given-names: Pascal
    orcid: "https://orcid.org/0000-0003-1192-0403"
  - family-names: Huard
    given-names: David
    orcid: "https://orcid.org/0000-0003-0311-5498"
  - family-names: Smith
    given-names: Trevor James
    orcid: "https://orcid.org/0000-0001-5393-8359"
  - family-names: Logan
    given-names: Travis
    orcid: "https://orcid.org/0000-0002-2212-9580"
  - family-names: Aoun
    given-names: Abel
    orcid: "https://orcid.org/0000-0003-2289-2890"
  - family-names: Lavoie
    given-names: Juliette
    orcid: "https://orcid.org/0000-0002-4708-5182"
  - family-names: Dupuis
    given-names: Éric
    orcid: "https://orcid.org/0000-0001-7976-4596"
  - family-names: Rondeau-Genesse
    given-names: Gabriel
    orcid: "https://orcid.org/0000-0003-3389-9406"
  - family-names: Alegre
    given-names: Raquel
    orcid: "https://orcid.org/0000-0002-6081-0721"
  - family-names: Barnes
    given-names: Clair
    orcid: "https://orcid.org/0000-0002-7806-7913"
  - family-names: Laperrière
    given-names: Alexis Beaupré
  - family-names: Biner
    given-names: Sébastien
    orcid: "https://orcid.org/0000-0001-7515-490X"
  - family-names: Caron
    given-names: David
  - family-names: Ehbrecht
    given-names: Carsten
  - family-names: Fyke
    given-names: Jeremy
    orcid: "https://orcid.org/0000-0002-4522-3019"
  - family-names: Keel
    given-names: Tom
    orcid: "https://orcid.org/0000-0001-9193-5271"
  - family-names: Labonté
    given-names: Marie-Pier
    orcid: "https://orcid.org/0000-0003-0738-3940"
  - family-names: Lierhammer
    given-names: Ludwig
    orcid: "https://orcid.org/0000-0002-7207-0003"
  - family-names: Low
    given-names: Jwen-Fai
    orcid: "https://orcid.org/0000-0001-6618-7443"
  - family-names: Quinn
    given-names: Jamie
  - family-names: Roy
    given-names: Philippe
    orcid: "https://orcid.org/0000-0003-1239-7589"
  - family-names: Squire
    given-names: Dougie
    orcid: "https://orcid.org/0000-0003-3271-6874"
  - family-names: Stephens
    given-names: Ag
    orcid: "https://orcid.org/0000-0002-1038-7988"
  - family-names: Tanguy
    given-names: Maliko
    orcid: "https://orcid.org/0000-0002-1516-6834"
  - family-names: Whelan
    given-names: Christopher
  date-published: 2023-05-18
  doi: 10.21105/joss.05415
  issn: 2475-9066
  issue: 85
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5415
  title: "xclim: xarray-based climate data analytics"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05415"
  volume: 8
title: "xclim: xarray-based climate data analytics"

---

Owner metadata

• Name: Ouranos inc.
• Login: Ouranosinc
• Email:
• Kind: organization
• Description: Consortium on regional climatology
• Website: www.ouranos.ca
• Location: Canada
• Twitter: ouranos_cc
• Company:
• Icon url: https://avatars.githubusercontent.com/u/1696763?v=4
• Repositories: 37
• Last ynced at: 2023-02-26T14:20:41.025Z
• Profile URL: https://github.com/Ouranosinc

---

GitHub Events

Total

• Create event: 119
• Release event: 7
• Issues event: 94
• Watch event: 24
• Delete event: 115
• Issue comment event: 469
• Push event: 623
• Pull request review comment event: 196
• Pull request event: 257
• Pull request review event: 296
• Fork event: 8

Last Year

• Create event: 119
• Release event: 7
• Issues event: 94
• Watch event: 24
• Delete event: 115
• Issue comment event: 469
• Push event: 623
• Pull request review comment event: 196
• Pull request event: 257
• Pull request review event: 296
• Fork event: 8

---

Committers metadata

Last synced: 4 days ago

Name	Email	Commits
Zeitsperre	1****e	2964
Pascal Bourgault	b****l@o****a	1384
Éric Dupuis	e****1@u****a	705
David Huard	h****d@o****a	676
bumpversion[bot]	b****]@o****a	244
pre-commit-ci[bot]	6****]	243
juliettelavoie	j****e@h****a	202
Ludwig.Lierhammer	l****r@h****e	160
dependabot[bot]	4****]	158
abel	a****n@c****r	149
Travis Logan	l****s@o****a	146
Adrien Lamarche	a****e@p****m	99
marielabonte	m****3@g****m	65
saschahofmann	s****a@g****m	62
Raquel Alegre	r****e@u****k	58
Thomasjkeel	t****l@g****m	51
seblehner	s****r@g****t	40
RondeauG	r****l@o****a	40
Sébastien Biner	s****r@g****m	30
dougiesquire	d****e@g****m	25
SarahG-579462	g****h@o****a	22
abel	a****n@c****r	21
Sarah G	9****2	11
abeaupre	b****s@o****a	8
Jeremy Fyke	j****e@c****a	8
Hem-W	h****g@o****m	8
Raquel Alegre	r****l	8
Jamie Quinn	j****n@j****m	7
Faisal Mahmood	f****7@g****m	7
Baptiste Hamon	b****n@p****z	7
and 24 more...

Committer domains:

• ouranos.ca: 10
• cerfacs.fr: 2
• umontreal.ca: 1
• hotmail.ca: 1
• hereon.de: 1
• ucl.ac.uk: 1
• geosphere.at: 1
• canada.ca: 1
• jamiejquinn.com: 1
• pg.canterbury.ac.nz: 1
• crim.ca: 1
• pop-os.localdomain: 1
• mail.utoronto.ca: 1
• yahoo.ca: 1
• unican.es: 1
• github.com: 1
• dkrz.de: 1
• hzg.de: 1
• external.eumetsat.int: 1
• fossa.io: 1
• stepsecurity.io: 1
• stfc.ac.uk: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/ouranosinc/xclim

---

---

---

Package metadata

• Total packages: 4
• Total downloads:
  • pypi: 117,564 last-month
• Total docker downloads: 88
• Total dependent packages: 15 (may contain duplicates)
• Total dependent repositories: 45 (may contain duplicates)
• Total versions: 288
• Total maintainers: 3

---

Dependencies

Score: 21.688470357348194