Merge pull request #110 from cerfacs-globc/feature/c3s_extract_funs

Feature/c3s extract funs
cerfacs-globc · Feb 1, 2022 · 03d7b83 · 03d7b83
2 parents 431be0c + 7523cf3
commit 03d7b83
Show file tree

Hide file tree

Showing 24 changed files with 5,740 additions and 638 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,13 @@
+version: 2
+
+sphinx:
+  configuration: doc/source/conf.py
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.8"
+
+python:
+   install:
+   - requirements: requirements_dev.txt
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -33,7 +33,6 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.autosectionlabel",
-    "nbsphinx",  # notebooks
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/doc/source/explanation/climate_indices.rst b/doc/source/explanation/climate_indices.rst
@@ -36,10 +36,113 @@ air temperature and precipitation variables can be computed with icclim:
     - 4 compound indices (CD, CW, WD, WW)
 
 Detailed description of each indice is available at https://www.ecad.eu/documents/atbd.pdf.
-
+See table below for a short description of each indices.
+The description is extracted from clix-meta.
 Initially icclim was designed for online computing of climate indices through the `climate4impact portal <https://climate4impact.eu>`_.
 In spite of existence of other packages able to compute climate indices (`CDO <https://code.mpimet.mpg.de/projects/cdo>`_, `R package <https://etccdi.pacificclimate.org/resources/software-library>`_ ),
 it was decided to develop a new software in Python.
 Python language was first of all chosen to interface with `PyWPS <https://pywps.org/>`_: Python implementation of Web Processing Service
 (WPS) Standard.
 Another reason was to interface eventually with the `OpenClimateGIS <https://github.com/NCPP/ocgis/>`_.
+
++-----------------+------------------------------------------------------------+
+| short name      |   Description                                              |
++=================+============================================================+
+| TG              |   Mean of daily mean temperature                           |
++-----------------+------------------------------------------------------------+
+| TN              |   Mean of daily minimum temperature                        |
++-----------------+------------------------------------------------------------+
+| TX              |   Mean of daily maximum temperature                        |
++-----------------+------------------------------------------------------------+
+| DTR             |   Mean Diurnal Temperature Range                           |
++-----------------+------------------------------------------------------------+
+| ETR             |   Intra-period extreme temperature range                   |
++-----------------+------------------------------------------------------------+
+| vDTR            |   Mean day-to-day variation in Diurnal Temperature Range   |
++-----------------+------------------------------------------------------------+
+| SU              |   Number of Summer Days (Tmax > 25C)                       |
++-----------------+------------------------------------------------------------+
+| TR              |   Number of Tropical Nights (Tmin > 20C)                   |
++-----------------+------------------------------------------------------------+
+| WSDI            |                                                            |
++-----------------+------------------------------------------------------------+
+| TG90p           |   Percentage of days when Tmean > 90th percentile          |
++-----------------+------------------------------------------------------------+
+| TN90p           |   Percentage of days when Tmin > 90th percentile           |
++-----------------+------------------------------------------------------------+
+| TX90p           |   Percentage of days when Tmax > 90th percentile           |
++-----------------+------------------------------------------------------------+
+| TXx             |   Maximum daily maximum temperature                        |
++-----------------+------------------------------------------------------------+
+| TNx             |   Maximum daily minimum temperature                        |
++-----------------+------------------------------------------------------------+
+| CSU             |   Maximum number of consecutive summer days (Tmax >25 C)   |
++-----------------+------------------------------------------------------------+
+| GD4             |   Growing degree days (sum of Tmean > 4 C)                 |
++-----------------+------------------------------------------------------------+
+| FD              |   Number of Frost Days (Tmin < 0C)                         |
++-----------------+------------------------------------------------------------+
+| CFD             |   Maximum number of consecutive frost days (Tmin < 0 C)    |
++-----------------+------------------------------------------------------------+
+| HD17            |   Heating degree days (sum of Tmean < 17 C)                |
++-----------------+------------------------------------------------------------+
+| ID              |   Number of sharp Ice Days (Tmax < 0C)                     |
++-----------------+------------------------------------------------------------+
+| TG10p           |   Percentage of days when Tmean < 10th percentile          |
++-----------------+------------------------------------------------------------+
+| TN10p           |   Percentage of days when Tmin < 10th percentile           |
++-----------------+------------------------------------------------------------+
+| TX10p           |   Percentage of days when Tmax < 10th percentile           |
++-----------------+------------------------------------------------------------+
+| TXn             |   Minimum daily maximum temperature                        |
++-----------------+------------------------------------------------------------+
+| TNn             |   Minimum daily minimum temperature                        |
++-----------------+------------------------------------------------------------+
+| CSDI            |                                                            |
++-----------------+------------------------------------------------------------+
+| CDD             |   Maximum consecutive dry days (Precip < 1mm)              |
++-----------------+------------------------------------------------------------+
+| PRCPTOT         |   Total precipitation during Wet Days                      |
++-----------------+------------------------------------------------------------+
+| RR1             |   Number of Wet Days (precip >= 1 mm)                      |
++-----------------+------------------------------------------------------------+
+| SDII            |   Average precipitation during Wet Days (SDII)             |
++-----------------+------------------------------------------------------------+
+| CWD             |   Maximum consecutive wet days (Precip >= 1mm)             |
++-----------------+------------------------------------------------------------+
+| R10mm           |   Number of heavy precipitation days (Precip >=10mm)       |
++-----------------+------------------------------------------------------------+
+| R20mm           |   Number of very heavy precipitation days (Precip >= 20mm) |
++-----------------+------------------------------------------------------------+
+| RX1day          |   Maximum 1-day precipitation                              |
++-----------------+------------------------------------------------------------+
+| RX5day          |   Maximum 5-day precipitation                              |
++-----------------+------------------------------------------------------------+
+| R75p            |                                                            |
++-----------------+------------------------------------------------------------+
+| R75pTOT         |                                                            |
++-----------------+------------------------------------------------------------+
+| R95p            |                                                            |
++-----------------+------------------------------------------------------------+
+| R95pTOT         |                                                            |
++-----------------+------------------------------------------------------------+
+| R99p            |                                                            |
++-----------------+------------------------------------------------------------+
+| R99pTOT         |                                                            |
++-----------------+------------------------------------------------------------+
+| SD              |   Mean of daily snow depth                                 |
++-----------------+------------------------------------------------------------+
+| SD1             |   Snow days (SD >= 1 cm)                                   |
++-----------------+------------------------------------------------------------+
+| SD5cm           |   Number of days with snow depth >= 5 cm                   |
++-----------------+------------------------------------------------------------+
+| SD50cm          |   Number of days with snow depth >= 50 cm                  |
++-----------------+------------------------------------------------------------+
+| CD              |                                                            |
++-----------------+------------------------------------------------------------+
+| CW              |                                                            |
++-----------------+------------------------------------------------------------+
+| WD              |                                                            |
++-----------------+------------------------------------------------------------+
+| WW              |                                                            |
++-----------------+------------------------------------------------------------+