icclim

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

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
✓
Academic publication links
Links to: zenodo.org
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.7%) to scientific vocabulary

Keywords

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

Keywords from Contributors

climate-science energy-system-model meteorology earth-science transformers oceanography energy-system geoscience anuclim climate-analysis

Last synced: 5 months ago · JSON representation

Repository

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

Basic Info

Host: GitHub
Owner: cerfacs-globc
License: apache-2.0
Language: Python
Default Branch: master
Homepage: https://icclim.readthedocs.io/en/latest/
Size: 32.1 MB

Statistics

Stars: 87
Watchers: 7
Forks: 32
Open Issues: 24
Releases: 43

Topics

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

Created about 12 years ago · Last pushed 6 months ago

Metadata Files

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

Name: CERFACS GLOBC
Login: cerfacs-globc
Kind: organization
Location: Toulouse, France

Website: https://www.cerfacs.fr/
Repositories: 10
Profile: https://github.com/cerfacs-globc

GitHub Events

Total

Issues event: 2
Watch event: 3
Issue comment event: 5
Push event: 68
Fork event: 1

Last Year

Issues event: 2
Watch event: 3
Issue comment event: 5
Push event: 68
Fork event: 1

Committers

Last synced: 6 months ago

All Time

Total Commits: 1,322
Total Committers: 17
Avg Commits per committer: 77.765
Development Distribution Score (DDS): 0.545

Past Year

Commits: 115
Committers: 5
Avg Commits per committer: 23.0
Development Distribution Score (DDS): 0.252

Top Committers

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 (Top 20 + Academic)

cerfacs.fr: 4 smhi.se: 2 ouranos.ca: 1 external.eumetsat.int: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 113
Total pull requests: 224
Average time to close issues: about 1 year
Average time to close pull requests: 7 days
Total issue authors: 27
Total pull request authors: 12
Average comments per issue: 2.64
Average comments per pull request: 0.98
Merged pull requests: 209
Bot issues: 0
Bot pull requests: 58

Past Year

Issues: 1
Pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 1
Pull request authors: 1
Average comments per issue: 0.0
Average comments per pull request: 0.0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 1

View more stats

Top Authors

Issue Authors

bzah (43)
pagecp (10)
marev711 (7)
MilkaRadojevic (7)
bekozi (5)
DamienIrving (5)
thebaptiste (5)
jackaranda (4)
pauliscuss (3)
maartenplieger (3)
armellereca (2)
igryski (2)
ritviksahajpal (2)
larsbarring (2)
zoezz96 (1)

Pull Request Authors

bzah (130)
pre-commit-ci[bot] (57)
xpivan (18)
bekozi (6)
pagecp (5)
ptrgast (2)
bascrezee (1)
jackaranda (1)
DamienIrving (1)
mauromussin (1)
dependabot[bot] (1)
aulemahal (1)

Top Labels

Issue Labels

bug (4) enhancement (4) priority (3) good first issue (2) roadmap-5.3 (2) roadmap-5.2.0 (2)

Pull Request Labels

enhancement (2) dependencies (1) github_actions (1)

Packages

Total packages: 3
Total downloads:
- pypi 56,819 last-month

Total dependent packages: 1
(may contain duplicates)
Total dependent repositories: 2
(may contain duplicates)
Total versions: 45
Total maintainers: 2

proxy.golang.org: github.com/cerfacs-globc/icclim

Documentation: https://pkg.go.dev/github.com/cerfacs-globc/icclim#section-documentation
License: apache-2.0
Latest release: v7.0.0+incompatible
published almost 2 years ago

Versions: 17
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 6 months ago

pypi.org: icclim

Python library for climate indices calculation.

Documentation: https://icclim.readthedocs.io/en/latest/how_to/index.html
License: Apache Software License
Latest release: 7.0.0
published almost 2 years ago

Versions: 21
Dependent Packages: 1
Dependent Repositories: 1
Downloads: 56,819 Last month

Rankings

Downloads: 2.7%

Forks count: 6.9%

Dependent packages count: 7.3%

Stargazers count: 8.2%

Average: 9.4%

Dependent repos count: 22.1%

Maintainers (2)

bzah pagecp

Last synced: 6 months ago

icclim (Index Calculation CLIMate) is a python library for climate indices calculation. It wraps xclim, xarray and dask in a staight forward API. It is first meant to compute the ECA&D indices but also provide an API to create customized indices based on a few operators.

Homepage: https://github.com/cerfacs-globc/icclim
License: Apache-2.0
Latest release: 6.0.0
published over 3 years ago

Versions: 7
Dependent Packages: 0
Dependent Repositories: 1

Rankings

Dependent repos count: 24.1%

Forks count: 30.6%

Average: 35.9%

Stargazers count: 37.3%

Dependent packages count: 51.5%

Last synced: 6 months ago

Dependencies

requirements.txt pypi

cftime *
dask *
dateparser *
distributed *
fsspec *
netCDF4 *
numpy *
pandas *
pandas >=1.3
pytest *
pyyaml *
rechunker >=0.3.3
setuptools *
xarray *
xclim *
zarr *

requirements_dev.txt pypi

black * development
cftime * development
dask * development
dateparser * development
flake8 * development
flake8-rst-docstrings * development
isort * development
netCDF4 * development
numpy * development
pandas * development
pandas >=1.3 development
pip * development
pre-commit >=2.9 development
psutil * development
pydata-sphinx-theme * development
pylint * development
pytest * development
pytest-cov * development
rechunker >=0.3.3 development
setuptools >=49.6.0 development
sphinx * development
twine * development
xarray * development
xclim * development
zarr * development

.github/workflows/ci.yml actions

MishaKav/pytest-coverage-comment main composite
actions/checkout v3 composite
actions/setup-python v2 composite

environment.yml pypi

setup.py pypi

icclim

Science Score: 36.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.rst

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

proxy.golang.org: github.com/cerfacs-globc/icclim

Rankings

pypi.org: icclim

Rankings

Maintainers (2)

conda-forge.org: icclim

Rankings

Dependencies