Logo
v0.40.0

Table of Contents:

  • xclim Official Documentation
  • About
    • Documentation
    • Contributing to xclim
    • How to cite this library
    • Credits
  • Installation
  • Basic Usage
  • Examples
  • Climate Indicators
  • Climate Indices
  • Health Checks
  • Unit Handling
  • Internationalization
  • Command Line Interface
  • Bias Adjustment and Downscaling Algorithms
  • Spatial Analogues
  • Contributing
  • Credits
  • History
  • Bibliography

User API

  • API

All Modules

  • xclim
xclim
  • xclim: Climate services library
  • Edit on GitHub

xclim: Climate services library Xclim

Downloads

Python Package Index Build Conda-forge Build Version

Documentation and Support

Documentation Status Gitter Chat

Open Source

License FAIR Software Compliance FOSSA DOI

Development Status

Build Status pre-commit.ci status Coveralls Python Black Open Source Security Foundation

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="YS")

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.

Documentation

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

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. There is also a chat room on gitter (Gitter Chat).

  • 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 use the bibliographical reference information available through Zenodo

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.

Previous Next

© Copyright 2018-2023, Ouranos Inc., Travis Logan, and contributors. Revision 4563218d.

Built with Sphinx using a theme provided by Read the Docs.