Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
71 commits
Select commit Hold shift + click to select a range
08d06be
add chapter water use and water use releated maps, update dedication …
StefaniaGrimaldi Apr 17, 2026
c0eb2d2
small edit water use and water use releated maps
StefaniaGrimaldi Apr 17, 2026
d7f6e20
small edit water use and water use releated maps
StefaniaGrimaldi Apr 17, 2026
476b7fe
small edit water use and water use releated maps
StefaniaGrimaldi Apr 17, 2026
960a6db
Update 3_step5_model-init docs
fuchsiger Apr 21, 2026
8b8caa7
update description lakes map, add description lakes table
StefaniaGrimaldi Apr 22, 2026
0053c11
update description reservoirs map, add description reservoirs table
StefaniaGrimaldi Apr 22, 2026
54de657
small changes reservoirs and lakes chapter
StefaniaGrimaldi Apr 22, 2026
820d3e5
add environmental flow description
StefaniaGrimaldi Apr 22, 2026
0e64842
add units water demand maps
StefaniaGrimaldi Apr 23, 2026
5c8ac43
update Annex State Variables
StefaniaGrimaldi Apr 28, 2026
9a7f8a2
small corrections to Annex State Variables
StefaniaGrimaldi Apr 28, 2026
7f5e35e
update Annex Parameters
StefaniaGrimaldi Apr 28, 2026
161d8c6
small changes Annex Parameters
StefaniaGrimaldi Apr 28, 2026
3259622
small changes Annex Parameters
StefaniaGrimaldi Apr 28, 2026
998d22b
Disclaimer: add how to request for help
StefaniaGrimaldi Apr 28, 2026
9d9a438
Disclaimer: small changes
StefaniaGrimaldi Apr 28, 2026
8e19608
Update references
StefaniaGrimaldi Apr 28, 2026
c9112b6
Update introduction
StefaniaGrimaldi Apr 28, 2026
de1f283
Update description channel geometry maps based on errors and inaccura…
StefaniaGrimaldi Apr 28, 2026
dc8fba9
small fixes 4_Static-Maps_channel-geometry
StefaniaGrimaldi Apr 28, 2026
9ed0d69
small fixes 4_Static-Maps_channel-geometry
StefaniaGrimaldi Apr 28, 2026
2dfa2e7
small fixes 4_annex_tests
StefaniaGrimaldi Apr 28, 2026
c1a4715
correct typos
StefaniaGrimaldi Apr 28, 2026
4fc4349
specify 0,1 values in domain map
StefaniaGrimaldi Apr 28, 2026
d077cd6
specify 0,1 values in domain map
StefaniaGrimaldi Apr 28, 2026
24fc6fd
add info lddrepair, lddmask
StefaniaGrimaldi Apr 28, 2026
1323691
udpate description chanbw EFAS and GloFAS maps, based on Choulga et a…
StefaniaGrimaldi Apr 29, 2026
dd0bcbb
correct broken links
StefaniaGrimaldi Apr 29, 2026
f23cff1
clarify channel mask map definition in LISFLOOD
StefaniaGrimaldi Apr 29, 2026
5fe5073
clarify chanbw
StefaniaGrimaldi Apr 29, 2026
a470fd0
small edits 2_ESSENTIAL_time-management
StefaniaGrimaldi Apr 29, 2026
c966832
small edits 2_ESSENTIAL_time-management
StefaniaGrimaldi Apr 29, 2026
f898c5c
update step3 preparing setting file
StefaniaGrimaldi Apr 29, 2026
a874203
small fixes step3 preparing setting file
StefaniaGrimaldi Apr 29, 2026
9cb4ddd
improve description model initialization
StefaniaGrimaldi Apr 29, 2026
530be51
review step4_preparing-input-files
StefaniaGrimaldi Apr 30, 2026
510b387
small fix step4_preparing-input-files
StefaniaGrimaldi Apr 30, 2026
24ccd4a
improvements to step5 model initialization
StefaniaGrimaldi Apr 30, 2026
cb84f23
small fixes step5
StefaniaGrimaldi Apr 30, 2026
40f1007
small fixes step5
StefaniaGrimaldi Apr 30, 2026
31df3f6
improvements to step5 model initialization
StefaniaGrimaldi Apr 30, 2026
9f78b86
improvements to step5 model initialization
StefaniaGrimaldi Apr 30, 2026
1e17f31
improvements to step5 and step6: describe cold and warm start in step6
StefaniaGrimaldi Apr 30, 2026
3af780f
small corrections to 3_step6_model-output
StefaniaGrimaldi Apr 30, 2026
b88cea1
improve title model installation
StefaniaGrimaldi May 11, 2026
364d470
re-organize ESSENTIAL info
StefaniaGrimaldi May 11, 2026
e7d1921
re-nme ESSENTIAL info
StefaniaGrimaldi May 11, 2026
d3e6e45
udpate config.yml
StefaniaGrimaldi May 11, 2026
b19ea06
re-organize steps
StefaniaGrimaldi May 11, 2026
7b6786d
review Annex Settings and Options
StefaniaGrimaldi May 13, 2026
dd9b635
review Annex Settings and Options
StefaniaGrimaldi May 13, 2026
eac3e39
review Annex Settings and Options
StefaniaGrimaldi May 13, 2026
dfe7475
review Annex Settings and Options
StefaniaGrimaldi May 13, 2026
28319d2
review Annex Settings and Options
StefaniaGrimaldi May 13, 2026
ab967cb
update descrition lfbinding and lfuser
StefaniaGrimaldi May 14, 2026
b4ec704
essential concepts: add hyperlinks
StefaniaGrimaldi May 14, 2026
1b1fb9f
re-organize sections
StefaniaGrimaldi May 14, 2026
f610eeb
review Annex Input Maps Standard modules. Rename Annexes to 5
StefaniaGrimaldi May 14, 2026
39d475e
remove duplicate file
StefaniaGrimaldi May 14, 2026
5482118
small fixes annex input maps
StefaniaGrimaldi May 14, 2026
70802bf
remove duplicate file
StefaniaGrimaldi May 14, 2026
b3db094
add reference to papers and JRC Data Catalogue Datasets in intro to s…
StefaniaGrimaldi May 14, 2026
e0763cb
add reference to papers and JRC Data Catalogue Datasets in intro to s…
StefaniaGrimaldi May 14, 2026
afed5df
add reference to papers and JRC Data Catalogue Datasets in intro to s…
StefaniaGrimaldi May 14, 2026
ed1be29
remove not available outputs from annex-output-files
StefaniaGrimaldi May 15, 2026
eff6450
small corrections to 5_annex_output_files
StefaniaGrimaldi May 22, 2026
773e7a1
Update temporal coverage for irrigated crops data
r3dmos Jun 5, 2026
ef53081
Merge branch 'development' into feature/docs
doc78 Jun 18, 2026
14e2bf1
remove outdated file
StefaniaGrimaldi Jun 18, 2026
5219a8f
Fixed relative paths in docs
doc78 Jun 18, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ pytest tests/ -m "slow"

These tests could take 30 minutes or several hours, depending on your machine.

You can find full description and implementation details at [Test documentation](https://ec-jrc.github.io/lisflood-code/4_annex_tests/) page.
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,
ensure to include tests with good coverage for it.
Expand Down
4 changes: 3 additions & 1 deletion docs/0_disclaimer/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Disclaimer

Both the program code and the 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 software 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.
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).
24 changes: 22 additions & 2 deletions docs/0_references/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Anderson, 2006Anderson, E., 2006. *Snow Accumulation and Ablation Model -- SNOW-

Aston, A.R., 1979. Rainfall interception by eight small trees. Journal of Hydrology 42, 383-396.

Bisselink, B., Bernhard, J., Gelati, E., Adamovic, M., Jacobs, C., Mentaschi, L., Lavalle, C. and De Roo, A., Impact of a changing climate, land use, and water usage on water resources in the Danube river basin, EUR 29228 EN, Publications Office of the European Union, Luxembourg, 2018, ISBN 978-92-79-85888-8, doi:10.2760/561327, JRC111817, https://publications.jrc.ec.europa.eu/repository/handle/JRC111817

Bódis, K., 2009. *Development of a data set for continental hydrologic modelling*. Technical Report EUR 24087 EN JRC Catalogue number: LB-NA-24087-EN-C, Institute for Environment and Sustainability, Joint Research Centre of the European Commission Land Management and Natural Hazards Unit Action FLOOD. Input layers related to topography, channel geometry, land cover and soil characteristics of European and African river basins.

Buchhorn, M., Lesiv, M., Tsendbazar, N.-E., Herold, M., Bertels, L., and Smets, B.: Copernicus Global Land Cover Layers - Collection 2. Remote Sensing 2020, 12Volume 108, 1044. doi:10.3390/rs12061044
Expand All @@ -18,16 +20,24 @@ Büttner, G., Kosztra, B., Maucha, G., Pataki, R., Kleeschulte, S., Hazeu, G., V

Carneiro Freire, S., Macmanus, K., Pesaresi, M., Doxsey-Whitfield, E., and Mills, J.: Development of new open and free multi-temporal global population grids at 250 m resolution. Geospatial Data in a Changing World; Association of Geographic Information Laboratories in Europe (AGILE) (Organiser). AGILE; 2016. JRC100523

**Choulga, M., Moschini, F., Mazzetti, C., Grimaldi, S., Disperati, J., Beck, H., Salamon, P., and Prudhomme, C.: Technical note: Surface fields for global environmental modelling, Hydrol. Earth Syst. Sci., 28, 2991–3036, https://doi.org/10.5194/hess-28-2991-2024, 2024.**

Chow, V.T., Maidment, D.R., Mays, L.M., 1988. Applied Hydrology, McGraw-Hill, Singapore, 572 pp.

De Roo, A., Bisselink, B., Guenther, S., Gelati, E. and Adamovic, M., Assessing the effects of water saving measures on Europe`s water resources, EUR 30361 EN, Publications Office of the European Union, Luxembourg, 2020, ISBN 978-92-76-21537-0, doi:10.2760/739798, JRC120388, https://publications.jrc.ec.europa.eu/repository/handle/JRC120388

De Roo, A., Thielen, J., Gouweleeuw, B., 2003. LISFLOOD, a Distributed Water-Balance, Flood Simulation, and Flood Inundation Model, User Manual version 1.2. Internal report, Joint Research Center of the European Communities, Ispra, Italy, 74 pp.

de Sousa, L. M., Poggio, L., Batjes, N. H., Heuvelink, G. B. M., Kempen, B., Riberio, E., and Rossiter, D.: SoilGrids 2.0: producing quality-assessed soil information for the globe, SOIL Discuss. [preprint], https://doi.org/10.5194/soil-2020-65, in review, 2020.
Poggio, L., de Sousa, L. M., Batjes, N. H., Heuvelink, G. B. M., Kempen, B., Ribeiro, E., and Rossiter, D.: SoilGrids 2.0: producing soil information for the globe with quantified spatial uncertainty, SOIL, 7, 217–240, https://doi.org/10.5194/soil-7-217-2021, 2021.

Fröhlich, W., 1996. Wasserstandsvorhersage mit dem Prgramm ELBA. Wasserwirtschaft Wassertechnik, ISSN: 0043-0986, Nr. 7, 1996, 34-37.

Gelati, E., Zajac, Z., Ceglar, A., Bassu, S., Bisselink, B., Adamovic, M., Bernhard, J., Malagó, A., Pastori, M., Bouraoui, F., and de Roo, A.: Assessing groundwater irrigation sustainability in the Euro-Mediterranean region with an integrated agro-hydrologic model, Adv. Sci. Res., 17, 227–253, https://doi.org/10.5194/asr-17-227-2020, 2020.

Goudriaan, J., 1977. Crop micrometeorology: a simulation study. Simulation Monographs. Pudoc, Wageningen.

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.

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
Expand All @@ -48,6 +58,10 @@ Molnau, M., Bissell, V.C., 1983. A continuous frozen ground index for flood fore

Rao, C.X. and Maurer, E.P., 1996. A simplified model for predicting daily transmission losses in a stream channel. Water Resources Bulletin, Vol. 31, No. 6., 1139-1146.

Reggiani, P., Todini, E., Meißner, D., 2014a. A conservative flow routing formulation: Déjà vu and the variable-parameter Muskingum method revisited. Journal of Hydrology, 519, 1506–1515. https://doi.org/10.1016/j.jhydrol.2014.08.057

Reggiani, P., Todini, E., Meißner, D., 2014b. Analytical solution of a kinematic wave approximation for channel routing. Hydrological Research, 45(1), 43–57. https://doi.org/10.2166/nh.2013.157

Schiavina, M., Freire, S., and MacManus, K.: GHS-POP R2019A - GHS population grid multitemporal (1975-1990-2000-2015). European Commission, Joint Research Centre (JRC), 2019. [Dataset] doi:10.2905/0C6B9751-A71F-4062-830B-43C9F432370F PID: http://data.europa.eu/89h/0c6b9751-a71f-4062-830b-43c9f432370f

Smets, B., Verger, A., Camacho, F., Van der Goten, R., and Jacobs, T.: Copernicus Global Land Operations ”Vegetation and Energy”: Product User Manual, Issue 1.33, 2019 [available online: https://land.copernicus.eu/global/sites/cgls.vito.be/files/products/CGLOPS1_PUM_LAI1km-V2_I1.33.pdf, last accessed: 13.05.2021.].
Expand All @@ -62,7 +76,13 @@ Supit, I., Hoojer, A.A., and Van Diepen, C.A.: System description of the Wofost

Supit, I. , van der Goot, E. (eds.), 2003. Updated System Description of the WOFOST Crop Growth Simulation Model as Implemented in the Crop Growth Monitoring System Applied by the European Commission, Treemail, Heelsum, The Netherlands, 120 pp.

Todini, E., 1996. The ARNO rainfall-runoff model. Journal of Hydrology 175, 339-382.
Tang, X., Samuels, P.G., 1999. Variable parameter Muskingum-Cunge method for flood routing in a compound channel. Journal of Hydraulic Research, 37, 591–614. https://doi.org/10.1080/00221689909498519

Todini, E., 1996. The ARNO rainfall----runoff model. Journal of Hydrology 175, 339-382.

Todini, E., 2007a. A mass conservative and water storage consistent variable parameter Muskingum-Cunge approach. Hydrology and Earth System Sciences, 11, 1645–1659. https://doi.org/10.5194/hess-11-1645-2007

Todini, E., 2007b. Corrigendum to "A mass conservative and water storage consistent variable parameter Muskingum-Cunge approach" published in Hydrology and Earth System Sciences, 11, 1645–1659. Hydrology and Earth System Sciences, 11, 1783–1783. https://doi.org/10.5194/hess-11-1783-2007

Tóth, B., Weynants, M., Nemes, A., Makó, A., Bilas, G., and Toth, G.: New generation of hydraulic pedotransfer functions for Europe. EUROPEAN JOURNAL OF SOIL SCIENCE 66 (1); 2015. p. 226-238. JRC91453

Expand Down
25 changes: 9 additions & 16 deletions docs/1_introduction_LISFLOOD/index.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,20 @@
## About LISFLOOD

LISFLOOD is a spatially distributed, semi-physical hydrological rainfall-runoff model that has been developed by the Joint Research Centre (JRC) of the European Commission in late 90s.
Since then, LISFLOOD has been applied to a wide range of applications such as all kind of water resources assessments looking at e.g.
the effects of climate and land-use change as well as river regulation measures.
Its most prominent application is probably within the [European Flood Awareness System, EFAS](https://www.efas.eu/en) and the [Global Flood Awareness System, GloFAS](https://www.globalfloods.eu/)
operated under [Copernicus Emergency Management System, EMS](https://emergency.copernicus.eu/).
LISFLOOD is a spatially distributed, physically based, hydrological rainfall-runoff-routing model that has been developed by the Joint Research Centre (JRC) of the European Commission since 1997.
Since then, LISFLOOD has proven to be suitable for a variety of applications, including flood simulation and forecasting; water resources assessment; analysis of the impacts of land use changes; river regulation measures, and other water management plans; climate change analysis.
Its most prominent application is probably within the [European Flood Awareness System, EFAS](https://european-flood.emergency.copernicus.eu/react) and the [Global Flood Awareness System, GloFAS](https://global-flood.emergency.copernicus.eu/react/)
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 model can be extended with additional modules when need arises, to satisfy the new target objective.
In that sense it can be extended to include anything from a better representation of a particular hydrological flow to the implementation of anthropogenic-influenced processes.
At the same time the model has been designed to be applied across a wide range of spatial and temporal scales.
LISFLOOD is grid-based, and applications so far have employed grid cells of as little as 100 metres for medium-sized catchments, to 5000 metres for modelling
the whole of Europe and up to 0.1° (around 10 km) for modelling globally. Long-term water balance can be simulated (using a daily time step),
as well as individual flood events (using hourly time intervals, or even smaller).
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 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 and PCRaster Model Framework, wrapped in a Python based interface.

The Python wrapper of LISFLOOD enables the user to control the model inputs and outputs and the selection of the model modules.
LISFLOOD runs on any operating system for which Python and PCRaster are available.
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.

[🔝](#top)
11 changes: 5 additions & 6 deletions docs/1_introduction_usermanual/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +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.

Lastly, we also share with you two other tools:
OS LISFLOOD users might also be interested in the following complemetary open-source repositories:

* LISVAP, our tool to calculate the evapotranspiration and
* our calibration tool that we've developed.
* [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/).
* [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)

LISVAP Source code is on LISVAP [GitHub repository](https://github.com/ec-jrc/lisflood-lisvap) while its documentation can be found at [LISVAP GitHub pages](https://ec-jrc.github.io/lisflood-lisvap/).

Calibration tool source code is on his dedicated [repository](https://github.com/ec-jrc/lisflood-calibration) while documentation is at [Calibration Tool GitHub Pages](https://ec-jrc.github.io/lisflood-calibration/).

[🔝](#top)
Loading
Loading