|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 <https://icclim.readthedocs.io/en/latest/explanation/climate_indices.html#icclim-capabilities>`_ 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 ... <https://icclim.readthedocs.io/en/latest/how_to/index.html>`_ documentation or
`our notebooks <https://icclim.readthedocs.io/en/latest/tutorials/index.html>`_.
Who use icclim
--------------
icclim is part of `C4I platform <https://dev.climate4impact.eu>`_ backend and is integrated in `CLIPC Portal <http://www.clipc.eu>`_.
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 <https://cerfacs.fr/en/>`_, 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 <https://carolepetetin.com>`_ and has been funded by the H2020 `IS-ENES3 <https://is.enes.org>`_ 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
Raw data
{
"_id": null,
"home_page": null,
"name": "icclim",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Christian Page <christian.page@cerfacs.fr>, Abel Aoun <aoun.abel@gmail.com>",
"keywords": "netcdf, climate, climate-indices, climate-indicators, xarray",
"author": null,
"author_email": "Christian Page <christian.page@cerfacs.fr>",
"download_url": "https://files.pythonhosted.org/packages/5c/c5/fe6f53c4ce4989f3d2e4ba5bfc6366ee35c0e75c433a051ff939f970e46c/icclim-7.0.0.tar.gz",
"platform": null,
"description": "|logo|\n======\n\n|build| |pypi| |ruff| |docs| |conda| |coverage| |doi|\n\nicclim is a Python library to compute climate indices.\nicclim name stands for index, calculation, climate.\n\nInstallation\n------------\n\nFrom pypi: ``pip install icclim``.\n\nFrom conda-forge: ``conda install -c conda-forge icclim``.\n\nFrom sources:\n - Clone the repository ``git clone https://github.com/cerfacs-globc/icclim.git``\n - Install icclim ``pip install .``\n\nHow to use icclim\n-----------------\n\nLet's count the number of days above 25\u00b0C for each year, which corresponds to the index ``SU``, from a `tasmax` variable scattered in multiple netcdf files.\n\n`SU` is one of the many index that can be computed with icclim. See `the documentation <https://icclim.readthedocs.io/en/latest/explanation/climate_indices.html#icclim-capabilities>`_ to explore what other index you can compute with icclim.\n\n.. code-block:: python\n\n import icclim\n\n summer_days = icclim.su(\n \"netcdf_files/tasmax_1990-2100.nc\", out_file=\"summer_days.nc\"\n )\n\nFor more examples on how to use icclim, see icclim's `How to ... <https://icclim.readthedocs.io/en/latest/how_to/index.html>`_ documentation or\n`our notebooks <https://icclim.readthedocs.io/en/latest/tutorials/index.html>`_.\n\n\nWho use icclim\n--------------\n\nicclim is part of `C4I platform <https://dev.climate4impact.eu>`_ backend and is integrated in `CLIPC Portal <http://www.clipc.eu>`_.\nicclim is also used by some independent researchers.\n\n\nWho made icclim\n---------------\n\nicclim has always been an open source project and was successfully made thanks to the joint effort of all its contributors.\nThe lead development is made at `CERFACS <https://cerfacs.fr/en/>`_, a research institution located in Toulouse, France.\n\nGrants\n~~~~~~\nThis open-source project has been possible thanks to funding by the European Commission projects:\n\n* FP7-CLIPC (2013-2016)\n* FP7-IS-ENES2 (2013-2017)\n* EUDAT2020 (2015-2018)\n* H2020-IS-ENES3 (2019-2023)\n\nThe beautiful icclim logo is a creation of `Carole Petetin <https://carolepetetin.com>`_ and has been funded by the H2020 `IS-ENES3 <https://is.enes.org>`_ project grant agreement No 824084 (2019-2023).\n\n\nIndices\n-------\nFor a detailed description of each ECA&D index, please visit: https://www.ecad.eu/documents/atbd.pdf\n\n..\n Pytest Coverage Comment:Begin\n\n.. |coverage| image:: https://img.shields.io/badge/Coverage-84%25-green.svg\n :target: https://github.com/cerfacs-globc/icclim/blob/master/README.rst#code-coverage\n :alt: Code coverage\n\n..\n Pytest Coverage Comment:End\n\n\n.. |docs| image:: https://readthedocs.org/projects/icclim/badge/?version=latest\n :target: https://icclim.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |pypi| image:: https://img.shields.io/pypi/v/icclim.svg\n :target: https://pypi.python.org/pypi/icclim\n :alt: Python Package Index Build\n\n.. |build| image:: https://github.com/cerfacs-globc/icclim/actions/workflows/ci.yml/badge.svg?branch=master\n :target: https://github.com/cerfacs-globc/icclim/actions/workflows/ci.yml\n :alt: Build Status\n\n.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/icclim.svg\n :target: https://anaconda.org/conda-forge/icclim\n :alt: Conda-forge Build Version\n\n.. |doi| image:: https://zenodo.org/badge/15936714.svg\n :target: https://zenodo.org/badge/latestdoi/15936714\n :alt: D.O.I link\n\n.. |logo| image:: https://github.com/cerfacs-globc/icclim/raw/master/doc/source/_static/logo_icclim_colored__displayed.svg\n :target: https://github.com/cerfacs-globc/icclim\n :alt: icclim\n :width: 200px\n\n.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Ruff\n",
"bugtrack_url": null,
"license": null,
"summary": "Python library for climate indices calculation.",
"version": "7.0.0",
"project_urls": {
"Documentation": "https://icclim.readthedocs.io/en/latest/how_to/index.html",
"Source": "https://github.com/cerfacs-globc/icclim/"
},
"split_keywords": [
"netcdf",
" climate",
" climate-indices",
" climate-indicators",
" xarray"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7704cd742c01c1dda47083a56ec17afa0263b3cd2b2633b4856a833878722036",
"md5": "e0290c8722a1d8e44c54aeee9db576d0",
"sha256": "a60f174cedd8aa3d0c57f2aed5afddf47c30efb07afc16ec53295c41b01f34b4"
},
"downloads": -1,
"filename": "icclim-7.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0290c8722a1d8e44c54aeee9db576d0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 124828,
"upload_time": "2024-04-30T14:45:05",
"upload_time_iso_8601": "2024-04-30T14:45:05.653936Z",
"url": "https://files.pythonhosted.org/packages/77/04/cd742c01c1dda47083a56ec17afa0263b3cd2b2633b4856a833878722036/icclim-7.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5cc5fe6f53c4ce4989f3d2e4ba5bfc6366ee35c0e75c433a051ff939f970e46c",
"md5": "3ccc554983d8cac16af22becd0c83843",
"sha256": "5b967c1f771d773cf1b8fe66a4a52fd1191bd5298724094b6ce119817a28deb1"
},
"downloads": -1,
"filename": "icclim-7.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3ccc554983d8cac16af22becd0c83843",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 3978568,
"upload_time": "2024-04-30T14:45:10",
"upload_time_iso_8601": "2024-04-30T14:45:10.231050Z",
"url": "https://files.pythonhosted.org/packages/5c/c5/fe6f53c4ce4989f3d2e4ba5bfc6366ee35c0e75c433a051ff939f970e46c/icclim-7.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 14:45:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cerfacs-globc",
"github_project": "icclim",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "icclim"
}
JSON
