Skip to content

Commit

Permalink
Merge pull request #164 from cerfacs-globc/doc/wording_on_readme
Browse files Browse the repository at this point in the history
DOC: Cleanup Readme file
  • Loading branch information
bzah authored Apr 27, 2022
2 parents 938de10 + d124432 commit 20da99d
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ icclim
|build| |pypi| |black| |docs| |conda| |coverage|

icclim is a Python library to compute climate indices.
icclim name stand for Index, Calculation, CLIMate.
icclim name stands for index, calculation, climate.

Installation
------------
Expand All @@ -20,7 +20,7 @@ From sources:
How to use icclim
-----------------

Let's count the number of days above 25ºC, which correspond the index ``SU``, from a `tasmax` variable scattered in multiple netcdf files.
Let's count the number of days above 25ºC, 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.

Expand All @@ -34,23 +34,22 @@ Let's count the number of days above 25ºC, which correspond the index ``SU``, f
out_file="summer_days.nc"
)
For more examples on how to use icclim, see our `How to ... <https://icclim.readthedocs.io/en/latest/how_to/index.html>`_ doc or
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://gitlab.com/is-enes-cdi-c4i/notebooks/-/tree/master/>`_.


Who use icclim
--------------

icclim is part of `C4I platform <https://dev.climate4impact.eu>`_ backend and is integrated in `CLIPC Portal <http://www.clipc.eu>`_.
You may also (soon) find icclim within the Copernicus C3S Climate Data Store (CDS).
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.
The lead development is made at `CERFACS <https://cerfacs.fr/en/>`_, a research institution located in Toulouse, France.

Grants
~~~~~~
Expand Down

0 comments on commit 20da99d

Please sign in to comment.