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 pypi: pip install icclim.

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

  • Install icclim pip install . -c constraints.txt (use the constraints file for a reproducible, validated environment)

Compatibility

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

  • Python: Supports Python 3.9 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 some 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)

  • EUDAT2020 (2015-2018)

  • H2020-IS-ENES3 (2019-2023)

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.0.5.tar.gz (3.9 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.0.5-py3-none-any.whl (125.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for icclim-7.0.5.tar.gz
Algorithm Hash digest
SHA256 0cf1b6a8bf3a11604922eb0bf9ff69b1fc821bb10cc87e9a6edb1b81971069c6
MD5 cb603bd2ca1fc7701ae0aa550a023848
BLAKE2b-256 83e731036339896029db1740c5c69bd6c6ec5aacc8c0eb662601b1811b700418

See more details on using hashes here.

Provenance

The following attestation bundles were made for icclim-7.0.5.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.0.5-py3-none-any.whl.

File metadata

  • Download URL: icclim-7.0.5-py3-none-any.whl
  • Upload date:
  • Size: 125.2 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.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c2106e5022f6d5456e574d85732c51bd4157684fc6546891034f4c35393066ce
MD5 9af051d87c7666a7c1b26e007db5feb2
BLAKE2b-256 b7b9f3196bbce6d56316fb497f57056c7c189e53238e5d4787d7bb6c3cd3e927

See more details on using hashes here.

Provenance

The following attestation bundles were made for icclim-7.0.5-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