icclim

Python library for climate indices and climate indicators calculation.
https://github.com/cerfacs-globc/icclim

Category: Climate Change
Sub Category: Climate Data Processing and Analysis

Keywords

calculation-climate climate-indicators climate-indices climate-simulations icclim netcdf python python-library python-package xarray xclim

Keywords from Contributors

earth-system-model climate climate-science netcdf4 anuclim climate-analysis meteorology oceanography spatial-data-analysis climate-datasets

Last synced: about 7 hours ago
JSON representation

Repository metadata

icclim: Python library for climate indices and climate indicators calculation.

• Host: GitHub
• URL: https://github.com/cerfacs-globc/icclim
• Owner: cerfacs-globc
• License: apache-2.0
• Created: 2014-01-15T14:04:03.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2026-08-04T08:45:50.000Z (9 days ago)
• Last Synced: 2026-08-05T13:48:35.258Z (8 days ago)
• Topics: calculation-climate, climate-indicators, climate-indices, climate-simulations, icclim, netcdf, python, python-library, python-package, xarray, xclim
• Language: Python
• Homepage: https://icclim.readthedocs.io/en/latest/
• Size: 34.3 MB
• Stars: 94
• Watchers: 6
• Forks: 34
• Open Issues: 13
• Releases: 49
• Metadata Files:
  • Readme: README.rst
  • Contributing: .github/CONTRIBUTING.rst
  • License: LICENSE
  • Citation: CITATION.cff

README.rst

          |logo|
======

|build| |pypi| |ruff| |docs| |conda| |coverage| |doi|

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.

.. code-block:: python

    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)
* Horizon Europe FUTURA and ENES-RISe (2026-2029)

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

..
  Pytest Coverage Comment:Begin

.. |coverage| image:: https://img.shields.io/badge/Coverage-82%25-green.svg
        :target: https://github.com/cerfacs-globc/icclim/blob/master/README.rst#code-coverage
        :alt: Code coverage

..
  Pytest Coverage Comment:End


.. |docs| image:: https://readthedocs.org/projects/icclim/badge/?version=latest
        :target: https://icclim.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. |pypi| image:: https://img.shields.io/pypi/v/icclim.svg
        :target: https://pypi.python.org/pypi/icclim
        :alt: Python Package Index Build

.. |build| image:: https://github.com/cerfacs-globc/icclim/actions/workflows/ci.yml/badge.svg?branch=master
        :target: https://github.com/cerfacs-globc/icclim/actions/workflows/ci.yml
        :alt: Build Status

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/icclim.svg
        :target: https://anaconda.org/conda-forge/icclim
        :alt: Conda-forge Build Version

.. |doi| image:: https://zenodo.org/badge/15936714.svg
        :target: https://zenodo.org/badge/latestdoi/15936714
        :alt: D.O.I link

.. |logo| image:: https://github.com/cerfacs-globc/icclim/raw/master/doc/source/_static/logo_icclim_colored__displayed.svg
        :target: https://github.com/cerfacs-globc/icclim
        :alt: icclim
        :width: 200px

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
        :target: https://github.com/astral-sh/ruff
        :alt: Ruff

        

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Page"
    given-names: "Christian"
    orcid: "https://orcid.org/0000-0002-4018-4720"
    affiliation: "CERFACS, Toulouse, France"
  - family-names: "Aoun"
    given-names: "Abel"
title: "icclim: Index Calculation CLIMate"
version: 7.1.6
doi: 10.5281/zenodo.6046052
date-released: 2026-07-22
url: "https://github.com/cerfacs-globc/icclim"
repository-code: "https://github.com/cerfacs-globc/icclim"
identifiers:
  - type: url
    value: "https://github.com/cerfacs-globc/icclim/tree/v7.1.6"
    description: "Specific version source code"
keywords:
  - "climate"
  - "climate indices"
  - "eca-d"
  - "xarray"
  - "xclim"
  - "dask"

---

Owner metadata

• Name: CERFACS GLOBC
• Login: cerfacs-globc
• Email:
• Kind: organization
• Description:
• Website: https://www.cerfacs.fr/
• Location: Toulouse, France
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/11227557?v=4
• Repositories: 10
• Last ynced at: 2023-08-10T06:01:01.496Z
• Profile URL: https://github.com/cerfacs-globc

---

GitHub Events

Total

• Create event: 43
• Commit comment event: 2
• Release event: 2
• Delete event: 29
• Pull request event: 22
• Fork event: 2
• Issues event: 4
• Watch event: 4
• Issue comment event: 20
• Push event: 219
• Pull request review event: 1

Last Year

• Create event: 43
• Commit comment event: 2
• Release event: 2
• Delete event: 29
• Pull request event: 22
• Fork event: 1
• Issues event: 2
• Watch event: 2
• Issue comment event: 15
• Push event: 153
• Pull request review event: 1

---

Committers metadata

Last synced: 1 day ago

Name	Email	Commits
abel	a****n@c****r	602
Christian Page	c****e@c****r	320
Natalia Tatatrinova	n****a@c****r	274
pre-commit-ci[bot]	6****]	112
Abel Aoun	a****l@o****m	95
GitHub Actions Bot		62
Natalia Tatarinova	s****a@g****m	39
Xpiv	x****s@g****m	28
Martin.Evaldsson	M****n@s****e	24
dependabot[bot]	4****]	16
Abel Aoun	a****n@e****t	16
github-actions[bot]	4****]	14
Natalia	t****a@c****r	6
Marion HOUDAYER	m****r@c****r	6
Lars Barring	l****g@s****e	5
bekozi	b****l@g****m	5
Marion HOUDAYER	h****r@r****r	4
Pascal Bourgault	b****l@o****a	2
Petros Gasteratos	p****t	2
Marion HOUDAYER	h****r@R****l	1
Damien Irving	i****n@g****m	1
bascrezee	b****e@g****m	1

Committer domains:

• cerfacs.fr: 5
• smhi.se: 2
• ouranos.ca: 1
• ryu.cerfacs.fr: 1
• external.eumetsat.int: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/cerfacs-globc/icclim

---

---

---

Package metadata

• Total packages: 3
• Total downloads:
  • pypi: 6,232 last-month
  • conda: 32,882 total
• Total dependent packages: 1 (may contain duplicates)
• Total dependent repositories: 2 (may contain duplicates)
• Total versions: 71
• Total maintainers: 2

---

Dependencies

Score: 18.338234849270066