Merge branch 'development' into feature/mct_optim

Author: doc78

.github/workflows/ci_env.yml

@@ -1,6 +1,11 @@
 name: Lisflood OS Unit Tests
 
-on: [push]
+# Controls when the workflow will run
+on:
+  push:
+    branches: [ "master", "development" ]
+  pull_request:
+    branches: [ "master", "development" ]
 
 jobs:
   tests:

.gitignore

@@ -25,3 +25,5 @@ lisflood_model.egg-info
 .coverage
 *.tox.ini
 .vscode/
+*.ipynb
+.ipynb_checkpoints/

docs/3_step3_preparing-setting-file/index.md

@@ -17,7 +17,7 @@ For simplicity reasons, we suggest to follow the following steps:
 3) 	parameter options
 4)	chose optional model routines (which ones are available; what they do; and how to “activate” them)
 
-In order to facilitate the preparation of the settings file, a complete example is provided [here](https://ec-jrc.github.io/lisflood-code/3_step3_preparing-setting-file/lisfloodSettings_reference.xml). The user is encouraged to update the paths, the names of the maps and of the tables in the provided template. Please note that the template contains all the settings for a warm start run; the paths to the initial maps must be replaced with the initial bogus values in order to perform a pre-run or a cold start run.
+In order to facilitate the preparation of the settings file, a complete example is provided [here](https://github.com/ec-jrc/lisflood-code/tree/master/src/lisfloodSettings_reference.xml). The user is encouraged to update the paths, the names of the maps and of the tables in the provided template. Please note that the template contains all the settings for a warm start run; the paths to the initial maps must be replaced with the initial bogus values in order to perform a pre-run or a cold start run.
 TIP:  *$(ProjectDir)* or *$(ProjectPath)* cab used as built-in variable in the XML settings, to refer the project folder.
 
 ### Time-related constants
@@ -731,8 +731,9 @@ Within the 'lfoptions' element of the settings file, each option is defined usin
 + **NetCDFTimeChunks**: chunking size in the time dimension. Recommended value is “auto" but chunking size can be specified manually or set to “-1" to load the whole time series into memory (very fast but expensive in terms of memory). 
 + **MapsCaching** (True or False): option designed for the lisflood calibration. If set to True, all the static maps and forcings will be stored in a cache so that they don't have to be loaded by each lisflood instance. This option sets the value of NetCDFTimeChunks to "-1", meaning that the whole time series in the NetCDF inputs is loaded into memory. 
 + **OutputMapsChunks**: this option is used to dump outputs to disk every X steps (default 1).  
++ **OutputMapsDataType**: this option sets the output data type and may take the following values: "float64" or "float32" (default float64)
 
 ### Reference settings file
-In order to facilitate the preparation of the settings file, a complete example is provided [here](../3_step3_preparing-setting-file/lisfloodSettings_reference.xml). The user is encouraged to update the paths, the names of the maps and of the tables in the provided template.
+In order to facilitate the preparation of the settings file, a complete example is provided [here](https://github.com/ec-jrc/lisflood-code/tree/master/src/lisfloodSettings_reference.xml). The user is encouraged to update the paths, the names of the maps and of the tables in the provided template.
 
 [:top:](#top)