Skip to content

Commit

Permalink
FIX: rst tables
Browse files Browse the repository at this point in the history
  • Loading branch information
Abel Aoun committed Dec 27, 2023
1 parent 76deac8 commit f22160c
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 31 deletions.
52 changes: 26 additions & 26 deletions doc/source/references/custom_indices.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,33 +36,33 @@ indices or user indices.

``user_index`` is a dictionary with possible keys:

+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| Key | Type of value | Description |
+========================+===========================================+======================================================================================+
| index_name | *str* | Name of custom index. |
+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| calc_operation | *str* | Type of calculation. See below for more details. |
+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| logical_operation | *str* | gt, lt, get, let or e |
+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| thresh | *float* or *str* | In case of percentile-based index, must be string which starts with "p" (e.g. |
| | | "p90"). |
+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| Key | Type of value | Description |
+=========================+===========================================+======================================================================================+
| index_name | *str* | Name of custom index. |
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| calc_operation | *str* | Type of calculation. See below for more details. |
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| logical_operation | *str* | gt, lt, get, let or e |
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| thresh | *float* or *str* | In case of percentile-based index, must be string which starts with "p" (e.g. |
| | | "p90"). |
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| link_logical_operations | *str* | and or or |
+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| extreme_mode | *str* | min or max for computing min or max of running mean/sum. |
+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| window_width | *int* | Used for computing running mean/sum. |
+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| coef | *float* | Constant for multiplying input data array. |
+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| date_event | *bool* | To keep or not the date of event. See below for more details. |
+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| var_type | *str* | "t" or "p". See below for more details. |
+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| ref_time_range | [*datetime.datetime*, | Time range of reference (baseline) period for computing anomalies. |
| | *datetime.datetime*] | |
+------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| extreme_mode | *str* | min or max for computing min or max of running mean/sum. |
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| window_width | *int* | Used for computing running mean/sum. |
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| coef | *float* | Constant for multiplying input data array. |
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| date_event | *bool* | To keep or not the date of event. See below for more details. |
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| var_type | *str* | "t" or "p". See below for more details. |
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+
| ref_time_range | [*datetime.datetime*, | Time range of reference (baseline) period for computing anomalies. |
| | *datetime.datetime*] | |
+-------------------------+-------------------------------------------+--------------------------------------------------------------------------------------+

Additional information about ``user_index`` keys are given below.

Expand Down
10 changes: 5 additions & 5 deletions doc/source/references/icclim_index_api.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ The ``in_files`` parameter can be
| simple index (based on a single | ``var_name`` = 'tasmax' | ``var_name`` = 'tasmax' |
| variable) | | |
+---------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| ``in_files`` = | ``in_files`` = ['tasmax_1990-2000.nc', |
| 'tasmax_1990-2010.nc' | 'tasmax_2000-2010.nc'] |
| ``in_files`` = | ``in_files`` = ['tasmax_1990-2000.nc', | |
| 'tasmax_1990-2010.nc' | 'tasmax_2000-2010.nc'] | |
+---------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| multivariable index (based on | ``var_name`` = ['tas', 'pr'] | ``var_name`` = ['tas', 'pr'] |
| several variables) | | |
+---------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| ``in_files`` = | ``in_files`` = ['tas_1990-2000.nc', 'tas_2000-2010.nc', |
| ['tas_1990-2010.nc', | 'pr_1990-2000.nc', 'pr_2000-2010.nc'] |
| 'pr_1990-2010.nc'] | |
| ``in_files`` = | ``in_files`` = ['tas_1990-2000.nc', 'tas_2000-2010.nc', | |
| ['tas_1990-2010.nc', | 'pr_1990-2000.nc', 'pr_2000-2010.nc'] | |
| 'pr_1990-2010.nc'] | | |
+---------------------------------+----------------------------------------------------------+---------------------------------------------------------------------------------------------------------+

New in 5.3
Expand Down

0 comments on commit f22160c

Please sign in to comment.