Skip to main content

Climate indices computation package based on Xarray.

Project description

Versions

Python Package Index Build Conda-forge Build Version

Documentation and Support

Documentation Status Gitter Chat Supported Python Versions

Open Source

License FAIR Software Compliance FOSSA DOI

Coding Standards

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

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="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.

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.41.0.tar.gz (779.2 kB view details)

Uploaded Source

Built Distribution

xclim-0.41.0-py3-none-any.whl (485.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xclim-0.41.0.tar.gz
  • Upload date:
  • Size: 779.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for xclim-0.41.0.tar.gz
Algorithm Hash digest
SHA256 aa6854bbed8887a24080aa2090c3a876c2cbd078d57ff4f05bd296079e076f07
MD5 b1eb61f7eab112d5175ad73c8ce9d66c
BLAKE2b-256 58825d3f987db8cd3d0053310f532ece6485fcf035f6b96adca81f3d661509ac

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xclim-0.41.0-py3-none-any.whl
  • Upload date:
  • Size: 485.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for xclim-0.41.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec027456eb1fbeb9eb29314ea4a000a93a5d85dfef975231e7576151180567d4
MD5 156f98458b6f735ee83fac3064bc9d19
BLAKE2b-256 0dff8b8f9a266449a993625af354e607e4522f40f65dff98e63c780da857ce35

See more details on using hashes here.

Supported by

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