Feature/docs

README.md

@@ -70,7 +70,7 @@ mkdir tests/data/LF_ETRS89_UseCase/out
 python src/lisf1.py tests/data/LF_ETRS89_UseCase/settings/cold.xml
 ```
 
-If the command above successed without errors, producing dis.nc into tests/data/LF_ETRS89_UseCase/out folder, your lisflood installation was correct.
+If the command above succeeded without errors, producing dis.nc into tests/data/LF_ETRS89_UseCase/out folder, your lisflood installation was correct.
 
 ### Docker image
 
@@ -154,7 +154,7 @@ These tests could take 30 minutes or several hours, depending on your machine.
 
 You can find full description and implementation details at [Test documentation](/docs/5_annex_tests/index.md) page.
 
-**Note**: If yuor pull request is about a new feature you may want to integrate in LISFLOOD,
+**Note**: If your pull request is about a new feature you may want to integrate in LISFLOOD,
 ensure to include tests with good coverage for it.
 
 For more info about pytest, see [official website](https://docs.pytest.org/en/latest/).

docs/0_disclaimer/index.md

@@ -2,4 +2,4 @@
 
 Both the source code and the OS LISFLOOD documentation (including the [LISFLOOD Model Documentation](https://ec-jrc.github.io/lisflood-model/), the [LISFLOOD User Guide](https://ec-jrc.github.io/lisflood-code/) and the [LISVAP documentation](https://ec-jrc.github.io/lisflood-lisvap/)) have been carefully inspected before publishing. However, no  warranties, either expressed or implied, are made concerning the accuracy, completeness, reliability, usability, performance, or fitness for any particular purpose of the information contained in this documentation, to the source code described in this documentation, and to other material supplied in connection therewith. The material is provided \"as is\". The entire risk as to its quality and performance is with the user.
 
-Users are encouraged to submit questions and/or report errors concering the Documentation, User Guide, source code by opening a new issue in https://github.com/ec-jrc/lisflood-code/issues (LISFLOOD) or in https://github.com/ec-jrc/lisflood-lisvap/issues (LISVAP).
+Users are encouraged to submit questions and/or report errors concerning the Documentation, User Guide, source code by opening a new issue in https://github.com/ec-jrc/lisflood-code/issues (LISFLOOD) or in https://github.com/ec-jrc/lisflood-lisvap/issues (LISVAP).

docs/0_references/index.md

@@ -2,7 +2,7 @@
 
 Allen, R. G., Pereira, L. S., Raes, D., and Smith, M.: FAO Irrigation and Drainage Paper No. 56: Crop Evapotranspiration (guidelines for computing crop water requirements), 1998. [available online: https://www.researchgate.net/publication/284300773_FAO_Irrigation_and_drainage_paper_No_56, last accessed: 13.05.2021.]
 
-Anderson, 2006Anderson, E., 2006. *Snow Accumulation and Ablation Model -- SNOW-17*. Technical report.
+Anderson, E., 2006. *Snow Accumulation and Ablation Model -- SNOW-17*. Technical report.
 
 Aston, A.R., 1979. Rainfall interception by eight small trees. Journal of Hydrology 42, 383-396.
 
@@ -38,7 +38,7 @@ Goudriaan, J., 1977. Crop micrometeorology: a simulation study. Simulation Monog
 
 Hanazaki, R., Yamazaki, D., & Yoshimura, K. (2022). Development of a reservoir flood control scheme for global flood models. Journal of Advances in Modeling Earth Systems, 14, e2021MS002944. https://doi.org/10.1029/2021MS002944
 
-Hock, 2003Hock, R., 2003. Temperature index melt modelling in mountain areas. *Journal of Hydrology*, 282(1-4), 104--115.
+Hock, R., 2003. Temperature index melt modelling in mountain areas. *Journal of Hydrology*, 282(1-4), 104--115.
 
 Laborte, A., Gutierrez, M., Balanza, J. et al. RiceAtlas, a spatial database of global rice calendars and production. Sci Data 4, 170074 (2017). https://doi.org/10.1038/sdata.2017.74
 
@@ -97,9 +97,9 @@ Van der Knijff, J. M., Younis, J. and de Roo, A. P. J.: LISFLOOD: A GIS-based di
 
 Van Genuchten, M.Th., 1980. A closed-form equation for predicting the hydraulic conductivity of unsaturated soils. Soil Science Society of America Journal 44, 892-898.
 
-Viviroli et al., 2009Viviroli, D., Zappa, M., Gurtz, J., & Weingartner, R., 2009. An introduction to the hydrological modelling system PREVAH and its pre- and post-processing-tools. *Environmental Modelling & Software*, 24(10), 1209--1222.
+Viviroli, D., Zappa, M., Gurtz, J., & Weingartner, R., 2009. An introduction to the hydrological modelling system PREVAH and its pre- and post-processing-tools. *Environmental Modelling & Software*, 24(10), 1209--1222.
 
-Vogt et al., 2007Vogt, J., Soille, P., de Jager, A., Rimaviciute, E., Mehl, W., Foisneau, S., Bodis, K., Dusart, M., Parachini, M., Hasstrup, P.,2007. *A pan-European River and Catchment Database*. JRC Reference Report EUR 22920 EN, Institute for Environment and Sustainability, Joint Research Centre of the European Commission.
+Vogt, J., Soille, P., de Jager, A., Rimaviciute, E., Mehl, W., Foisneau, S., Bodis, K., Dusart, M., Parachini, M., Hasstrup, P.,2007. *A pan-European River and Catchment Database*. JRC Reference Report EUR 22920 EN, Institute for Environment and Sustainability, Joint Research Centre of the European Commission.
 
 Von Hoyningen-Huene, J., 1981. Die Interzeption des Niederschlags in landwirtschaftlichen Pflanzenbeständen (Rainfall interception in agricultural plant stands). In: Arbeitsbericht Deutscher Verband für Wasserwirtschaft und Kulturbau, DVWK, Braunschweig, p.63.
 

docs/1_introduction_LISFLOOD/index.md

@@ -6,15 +6,15 @@ Its most prominent application is probably within the [European Flood Awareness
 operated under [Copernicus Emergency Management System, CEMS](https://emergency.copernicus.eu/).
 
 Its wide applicability is due to its modular structure as well as its temporal and spatial flexibility. 
-The user to control the model inputs and outputs and the selection of the model modules.
+The user can control the model inputs and outputs and the selection of the model modules.
 The model can be extended with additional modules when need arises, to satisfy the new target objective. 
 At the same time the model has been designed to be applied across a wide range of spatial and temporal scales. 
-OS LISFLOOD is grid-based, and applications so far have employed grid cells of as little as 100 metres for medium-sized catchments, and up kilometer scale for continental and global applications. 
+OS LISFLOOD is grid-based, and applications so far have employed grid cells of as little as 100 metres for medium-sized catchments, and up to kilometer scale for continental and global applications. 
 OS LISFLOOD can be used to generate long-term water balance simulations (climatology runs, with hourly to daily time steps), as well as individual flood events (with hourly to daily time steps). 
 
 Although LISFLOOD's primary output product is channel discharge, all internal rate and state variables (soil moisture, for example) can be written as output as well.
 All output can be written as grids, or time series at user-defined points or areas. The user has complete control over how output is written, thus minimising any waste of disk space or CPU time.
 
-LISFLOOD is implemented in Python high level language: the users are recommented to refer to the chapter [Installation of the LISFLOOD model](../2_installation/index.md) and to the readme of the [OS LISFLOOD GitHub repository](https://github.com/ec-jrc/lisflood-code#lisflood-os) to find detailed information on requirements and installation protocol.
+LISFLOOD is implemented in Python high level language: the users are recommended to refer to the chapter [Installation of the LISFLOOD model](../2_installation/index.md) and to the readme of the [OS LISFLOOD GitHub repository](https://github.com/ec-jrc/lisflood-code#lisflood-os) to find detailed information on requirements and installation protocol.
 
 [🔝](#top)

docs/1_introduction_usermanual/index.md

@@ -8,12 +8,12 @@ In order to apply this knowledge into practice, we provide two fully implemented
 
 Note, this document is **not a LISFLOOD model documentation**. The [lisflood-model official documentation](https://ec-jrc.github.io/lisflood-model/) contains the most up-to-date and complete technical documentation of the LISFLOOD model. This includes all the concepts and model equations of all the standard LISFLOOD processes, but also all the optional modules. 
 
-OS LISFLOOD users might also be interested in the following complemetary open-source repositories:
+OS LISFLOOD users might also be interested in the following complementary open-source repositories:
 
-* [LISVAP](https://github.com/ec-jrc/lisflood-lisvap) allows the computation of reference evapotrasnpiration gridded dataset. The relevant documentation can be found at [LISVAP documentation](https://ec-jrc.github.io/lisflood-lisvap/)
-* [OS LISFLOOD calibration tool](https://github.com/ec-jrc/lisflood-calibration) enables model parameter documentation. The relevant documentation is available at [Calibration Tool documentation](https://ec-jrc.github.io/lisflood-calibration/).
+* [LISVAP](https://github.com/ec-jrc/lisflood-lisvap) allows the computation of reference evapotranspiration gridded dataset. The relevant documentation can be found at [LISVAP documentation](https://ec-jrc.github.io/lisflood-lisvap/)
+* [OS LISFLOOD calibration tool](https://github.com/ec-jrc/lisflood-calibration) enables model parameter calibration. The relevant documentation is available at [Calibration Tool documentation](https://ec-jrc.github.io/lisflood-calibration/).
 * [OS LISFLOOD utilities](https://github.com/ec-jrc/lisflood-utilities) support the preparation of model inputs, the post-processing and comparison of model outputs. The relevant documentation is provided in the [lisflood-utilities repository](https://github.com/ec-jrc/lisflood-utilities#lisflood-utilities).
-* [pyg2p](https://github.com/ec-jrc/pyg2p) allows re-gridding and interpolation of meteorological files in GRIB format to nectdf (and pcraster) format. The relevant documentation is provided in the [pyg2p repositrory](https://github.com/ec-jrc/pyg2p#pyg2p)
+* [pyg2p](https://github.com/ec-jrc/pyg2p) allows re-gridding and interpolation of meteorological files in GRIB format to NetCDF (and pcraster) format. The relevant documentation is provided in the [pyg2p repository](https://github.com/ec-jrc/pyg2p#pyg2p)
 
 
 [🔝](#top)

docs/2_installation/index.md

@@ -56,7 +56,7 @@ Using conda environment is very handy since installing latest PCRaster and its d
 1. Install [miniconda](https://docs.conda.io/en/latest/miniconda.html) 
 2. Create a conda env named "lisflood" and install dependencies:
 ```
-conda create --name lisflood python=3.8 -c conda-forge
+conda create --name lisflood python=3.10 -c conda-forge
 conda activate lisflood
 conda install -c conda-forge pcraster
 pip install lisflood-model

docs/3_step1_ESSENTIAL_concepts_to_get_started/index.md

@@ -11,13 +11,13 @@ In order the run a simulation you will need:
 
   -   Meteo input maps 
   -   Static input maps 
-  -   Tables, only in case specific features such as reservoirs and lakes are included in the modeling excercis
+  -   Tables, only in case specific features such as reservoirs and lakes are included in the modeling exercise
   -   An empty output directory where all model data can be written 
   -   OS LISFLOOD settings file in .xml format
 
 The section [Input files](../3_step3_preparing-input-files/index.md) provides a detailed description of input maps and tables.
 
-The settings file (settings.xml) allows the selection of input maps, modelling options, and output variables and storage folder. The settings .xml is the essential argument of OS LISFLOOD command line. The section below presents its main components, an in depth descrition is provided in the section [Step 2: Preparing the Settings file](../3_step2_preparing-setting-file/index.md).
+The settings file (settings.xml) allows the selection of input maps, modelling options, and output variables and storage folder. The settings .xml is the essential argument of OS LISFLOOD command line. The section below presents its main components, an in depth description is provided in the section [Step 2: Preparing the Settings file](../3_step2_preparing-setting-file/index.md).
 
 
 ## OS LISFLOOD settings file (settings.xml)
@@ -65,9 +65,9 @@ The sections ‘lfuser’, ‘lfoptions’ and ‘lfbinding’' have different p
      For example:
 
 ```xml
-     'lfuser' secttion: 
+     'lfuser' section: 
      <textvar name="IrrigationEfficiency" value="$(PathMaps)/irrigation_efficiency_baseline.nc"></textvar>
-     'lfbinding' secttion: 
+     'lfbinding' section: 
      <textvar name="IrrigationEfficiency" value="$(IrrigationEfficiency)"></textvar>
 ```