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

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

Last synced: about 12 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 11 years ago)
• Default Branch: master
• Last Pushed: 2025-04-14T16:30:17.000Z (12 days ago)
• Last Synced: 2025-04-17T23:54:10.134Z (9 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: 32.1 MB
• Stars: 85
• Watchers: 7
• Forks: 33
• Open Issues: 24
• Releases: 43
• Metadata Files:
  • Readme: README.rst
  • Contributing: .github/CONTRIBUTING.rst
  • License: LICENSE

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

From conda-forge: ``conda install -c conda-forge icclim``.

From sources:
    - Clone the repository ``git clone https://github.com/cerfacs-globc/icclim.git``
    - Install icclim ``pip install .``

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 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

..
  Pytest Coverage Comment:Begin

.. |coverage| image:: https://img.shields.io/badge/Coverage-84%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

        

---

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

• Issues event: 2
• Watch event: 2
• Issue comment event: 4
• Push event: 45
• Fork event: 1

Last Year

• Issues event: 2
• Watch event: 2
• Issue comment event: 4
• Push event: 45
• Fork event: 1

---

Committers metadata

Last synced: 7 days ago

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

Committer domains:

• cerfacs.fr: 4
• smhi.se: 2
• ouranos.ca: 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: 2
• Total downloads:
  • pypi: 53,650 last-month
• Total dependent packages: 1 (may contain duplicates)
• Total dependent repositories: 2 (may contain duplicates)
• Total versions: 28
• Total maintainers: 2

---

Dependencies

Score: 18.414891166646587