Skip to main content

Derived climate variables built with xarray.

Project description

====== xclim

.. image:: _static/_images/xclim-logo.png :align: center :target: _static/_images/xclim-logo.png :alt: xclim

.. image:: :target: :alt: Python Package Index Build

.. image:: :target: :alt: Build Status

.. image:: :target: :alt: Coveralls

.. image:: :target: :alt: CodeFactor

.. image:: :target: :alt: Documentation Status

.. image:: :target: :alt: DOI

.. image:: :target: :alt: License

xclim is a library of functions to compute climate indices. It is built using xarray and can benefit from the parallelization handling provided by dask. Its objective is to make it as simple as possible for users to compute indices from large climate datasets and for scientists to write new indices with very little boilerplate.

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.icclim.TG(ds.tas, freq='YS')

For applications where meta-data and missing values are important to get right, xclim also provides a class for each index that validates inputs, checks for missing values, converts units and assigns metadata attributes to the output. This provides a mechanism for users to customize the indices to their own specifications and preferences.

xclim is still in active development at the moment, but is close to being production ready. We're are currently nearing a release candidate (as of Q2 2019). If you're interested in participating to the development, please leave us a message on the issue tracker.


This work is made possible thanks to the contributions of the Canadian Center for Climate Services.

This package was created with Cookiecutter_ and the audreyr/cookiecutter-pypackage_ project template.

.. _Cookiecutter: .. _audreyr/cookiecutter-pypackage:

======= History

0.10.2-beta (2019-06-18)

  • Added utilities with ensemble, run length, and subset algorithms to the documentation.

0.10.1-beta ()

  • Migrated to a major.minor.patch-release semantic versioning system.
  • Removed attributes in netCDF output from Indicators that are not in the CF-convention.
  • Added fit indicator to fit the parameters of a distribution to a series.

0.10-beta (2019-06-06)

  • Indicators are now split into packages named by realms. import xclim.atmos is now the method for loading indicators related to atmospheric variables.
  • Removed support for Python 2 compatibility.
  • Added support for period of the year subsetting in checks.missing_any.
  • Now allow for passing positive longitude values when subsetting data with negative longitudes.
  • Improved runlength calculations for small grid size arrays via ufunc_1dim flag.

0.9-beta (2019-05-13)


0.8-beta (2019-02-11)


0.7-beta (2019-02-05)

Major Changes:

  • Support for resampling of data structured using non-standard CF-Time calendars.
  • Added several ICCLIM and other indicators.
  • Dropped support for Python 3.4.
  • Now under Apache v2.0 license.
  • Stable PyPI-based dependencies.
  • Dask optimizations for better memory management.
  • Introduced class-based indicator calculations with data integrity verification and CF-Compliant-like metadata writing functionality.

Class-based indicators are new methods that allow index calculation with error-checking and provide on-the-fly metadata checks for CF-Compliant (and CF-compliant-like) data that are passed to them. When written to NetCDF, outputs of these indicators will append appropriate metadata based on the indicator, threshold values, moving window length, and time period / resampling frequency examined.

0.6-alpha (2018-10-03)

  • File attributes checks.
  • Added daily downsampler function.
  • Better documentation on ICCLIM indices.

0.5-alpha (2018-09-26)

  • Added total precipitation indicator.

0.4-alpha (2018-09-14)

  • Fully PEP8 compliant and available under MIT License.

0.3-alpha (2018-09-4)

  • Added icclim module.
  • Reworked documentation, docs theme.

0.2-alpha (2018-08-27)

  • Added first indices.

0.1.0-dev (2018-08-23)

  • First release on PyPI.

Project details

Download files

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

Files for xclim, version 0.10.2b0
Filename, size File type Python version Upload date Hashes
Filename, size xclim-0.10.2b0-py2.py3-none-any.whl (33.5 MB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size xclim-0.10.2b0.tar.gz (33.5 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page