Skip to main content

Python library for climate indices calculation.

Project description

Build Status Python Package Index Build Ruff Documentation Status Conda-forge Build Version Code coverage D.O.I link

icclim is a Python library to compute climate indices. icclim name stands for index, calculation, climate.

Installation

From conda-forge (recommended): conda install -c conda-forge icclim.

From pypi: pip install icclim.

From sources:
  • Clone the repository git clone https://github.com/cerfacs-globc/icclim.git

  • Install icclim pip install .

Compatibility

icclim is designed to be highly compatible across the Python scientific ecosystem:

  • Python: Supports Python 3.10 and above.

  • Backward Compatibility: Supports older stable versions (e.g., numpy>=1.21, xarray>=2022.6, xclim>=0.45).

  • Bleeding Edge: Fully verified and recommended to run on the latest major versions, including Zarr 3.x, Pandas 3.x, and Xarray 2026.x.

For production environments, we recommend keeping your dependencies updated to their latest stable releases to benefit from the latest optimizations and features.

How to use icclim

Let’s count the number of days above 25°C for each year, which corresponds to the index SU, from a tasmax variable scattered in multiple netcdf files.

SU is one of the many index that can be computed with icclim. See the documentation to explore what other index you can compute with icclim.

import icclim

summer_days = icclim.su(
    "netcdf_files/tasmax_1990-2100.nc", out_file="summer_days.nc"
)

For more examples on how to use icclim, see icclim’s How to … documentation or our notebooks.

Who use icclim

icclim is part of C4I platform backend and is integrated in CLIPC Portal. icclim is also used by independent researchers.

Who made icclim

icclim has always been an open source project and was successfully made thanks to the joint effort of all its contributors. The lead development is made at CERFACS, a research institution located in Toulouse, France.

Grants

This open-source project has been possible thanks to funding by the European Commission projects:

  • FP7 CLIPC (2013-2016)

  • FP7 IS-ENES2 (2013-2017)

  • H2020 EUDAT2020 (2015-2018)

  • H2020 IS-ENES3 (2019-2023)

This project also receives funding from Agence Nationale de la Recherche - France 2030 as part of the PEPR TRACCS programme under grant number ANR-22-EXTR-0003 (PC2-INVEST 2024-2032).

The beautiful icclim logo is a creation of Carole Petetin and has been funded by the H2020 IS-ENES3 project grant agreement No 824084 (2019-2023).

Indices

For a detailed description of each ECA&D index, please visit: https://www.ecad.eu/documents/atbd.pdf

Project details


Download files

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

Source Distribution

icclim-7.1.0.tar.gz (6.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

icclim-7.1.0-py3-none-any.whl (132.1 kB view details)

Uploaded Python 3

File details

Details for the file icclim-7.1.0.tar.gz.

File metadata

  • Download URL: icclim-7.1.0.tar.gz
  • Upload date:
  • Size: 6.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for icclim-7.1.0.tar.gz
Algorithm Hash digest
SHA256 04af9ce21a0673b3a98a5ba5ce89f9ebb4f89db944edabdbde26b0aafe5ff764
MD5 33e40b21861ebad315213893c6787e13
BLAKE2b-256 0f8a70008d55eb9608c82b7b59f555bc6f6d6b11952e3e3253138344e03087aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for icclim-7.1.0.tar.gz:

Publisher: publish-to-pipy.yml on cerfacs-globc/icclim

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

File details

Details for the file icclim-7.1.0-py3-none-any.whl.

File metadata

  • Download URL: icclim-7.1.0-py3-none-any.whl
  • Upload date:
  • Size: 132.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for icclim-7.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7141ba35d2aa06e7d1e076ea2bf425256853285ce3d125481bd99448023d3774
MD5 942a8354c500ddc6e49cad5e109cf52a
BLAKE2b-256 4acb934c3b35751dc8f6cdd36666b71d0dc84c1e8031fc1d4cebc2ad5fa51230

See more details on using hashes here.

Provenance

The following attestation bundles were made for icclim-7.1.0-py3-none-any.whl:

Publisher: publish-to-pipy.yml on cerfacs-globc/icclim

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 Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page