Skip to main content

Climate indices computation package based on Xarray.

Project description

Versions

Python Package Index Build Conda-forge Build Version Supported Python Versions

Documentation and Support

Documentation Status Static Badge

Open Source

License Open Source Security Foundation Scorecard DOI pyOpenSci JOSS

Coding Standards

Ruff pre-commit.ci status Open Source Security Foundation Best Practices FOSSA

Development Status

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Build Status 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:

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.

Quick Install

xclim can be installed from PyPI:

$ pip install xclim

or from Anaconda (conda-forge):

$ 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.

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:

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.

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 Static Badge first!

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

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

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).

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

(main branch)

Energy Usage

Energy Consumption (Last run) Energy Consumption (Last 90 days moving average) Energy Consumption (Total)

Carbon Emissions

Carbon Emissions (Last run) Carbon Emissions (Last 90 days moving average) Carbon Emissions (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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xclim-0.57.0.tar.gz (861.5 kB view details)

Uploaded Source

Built Distribution

xclim-0.57.0-py3-none-any.whl (365.4 kB view details)

Uploaded Python 3

File details

Details for the file xclim-0.57.0.tar.gz.

File metadata

  • Download URL: xclim-0.57.0.tar.gz
  • Upload date:
  • Size: 861.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for xclim-0.57.0.tar.gz
Algorithm Hash digest
SHA256 eda2efa62947507212fb132ab1b09352ec91352abd6de1918db58bbe2669128f
MD5 81ba769c66fc93d0a7e6d0526aeb0db8
BLAKE2b-256 9f51c2b702b844f505ffcbfebc3f59f08d796542aa7a6fec17b7013e7ca279be

See more details on using hashes here.

Provenance

The following attestation bundles were made for xclim-0.57.0.tar.gz:

Publisher: publish-pypi.yml on Ouranosinc/xclim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file xclim-0.57.0-py3-none-any.whl.

File metadata

  • Download URL: xclim-0.57.0-py3-none-any.whl
  • Upload date:
  • Size: 365.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for xclim-0.57.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2ae5648d89b7179427290933c4176bc22d76cc2a109ccaef17c1c5a6dbee3aaa
MD5 fedada5f7e42f6ee932eb0f95f17af8b
BLAKE2b-256 7b40c6764eae3ee81f521902ed5e1baf712e4b8db3b7ea7a5353cdd383369ff5

See more details on using hashes here.

Provenance

The following attestation bundles were made for xclim-0.57.0-py3-none-any.whl:

Publisher: publish-pypi.yml on Ouranosinc/xclim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page