Updated to version 4.1.1. Fixed documentation to account for the code…

… modification.
cerfacs-globc · Dec 17, 2015 · 62b9ae8 · 62b9ae8
1 parent 0d8bbff
commit 62b9ae8
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 9 deletions.
diff --git a/icclim/icclim_doc/source/conf.py b/icclim/icclim_doc/source/conf.py
@@ -59,7 +59,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '4.1.0'
+version = '4.1.1'
 # The full version, including alpha/beta/rc tags.
 release = version
 

diff --git a/icclim/icclim_doc/source/installation.rst b/icclim/icclim_doc/source/installation.rst
@@ -46,7 +46,7 @@ To get the version of installed library, do the following:
 .. code-block:: sh
 
     >>> icclim.__version__
-    4.1.0
+    4.1.1
 
 
 .. note:: ICCLIM was not tested on Windows and Mac platforms...
diff --git a/icclim/icclim_doc/source/python_api.rst b/icclim/icclim_doc/source/python_api.rst
@@ -422,8 +422,6 @@ Correspondence table "cal_operation" -- required/optional parameters:
 |'run_mean'/'run_sum'           |'extreme_mode',                |'coef',                |
 |                               |'window_width'                 |'date_event'           |
 +-------------------------------+-------------------------------+-----------------------+
-|'anomaly'                      |'ref_time_range'               |                       |
-+-------------------------------+-------------------------------+-----------------------+
 
 .. warning:: The 'window_width' here is a parameter for calculation of statistics in running window. Do not confuse with 'window_width' of :func:`icclim.indice`, which is used for computing of temperature percentiles and set to 5 as default. 
 
@@ -683,16 +681,15 @@ Example 14: Custom indice (anomaly of tasmax between 2 period of 30 years)
 .. code-block:: python
 
 	my_indice_params = {'indice_name': 'my_indice',
-                            'calc_operation': 'anomaly',
-	                    'ref_time_range': [datetime.datetime(1901,01,01), datetime.datetime(1930,12,31)], ### reference period: past period 
-
+                            'calc_operation': 'anomaly'
 	                   }
 
 	file_tasmax = 'tasmax_day_CNRM-CM5_historical_r1i1p1_19010101-20001231.nc'
 	out_f = 'my_indice.nc'
 	tr = [datetime.datetime(1971,01,01), datetime.datetime(2000,12,31)] ### studied period: future period
+        tr_base = [datetime.datetime(1901,01,01), datetime.datetime(1930,12,31)] ### reference period: past period
 	
-	icclim.indice(user_indice=my_indice_params, in_files=file_tasmax, var_name='tasmax', time_range=tr, out_file=out_f, callback=callback.defaultCallback2)
+	icclim.indice(user_indice=my_indice_params, in_files=file_tasmax, var_name='tasmax', time_range=tr, base_period_time_range=tr_base, out_file=out_f, callback=callback.defaultCallback2)
 
 
 Example 15: Multivariable custom indice (number of days when tasmin >= 10 degrees Celsius and tasmax > 25 degrees Celsius)

diff --git a/setup.py b/setup.py
@@ -32,7 +32,7 @@
 
     # la version du code
 
-    version="4.1.0",
+    version="4.1.1",
 
     # Liste les packages a inserer dans la distribution
     # plutot que de le faire a la main, on utilise la foncton