Welcome to AeoLiS’s Documentation

---

This documentation describes the Python implementation of the AeoLiS. AeoLiS is an aeolian sediment transport and landform evolution model that is designed to account for sediment-supply-limiting factors in coastal environments. The source code of the Python implementation can be found in GitHub.

The code is developed and maintained by a developer group that consists of members from Deltares, U.S. Army Engineer Research and Development Center (ERDC), Delft University of Technology, Oregon State University, and Lund University. We encourage contributions from the community. If you are interested in contributing to the code, please read the developer documentation.

Fig. 1 AeoLiS developer group

Contents

User Documentation

• Introduction
  • Model overview
  • Applicability and limitations
  • AeoLiS publications
    • 2024
    • 2023
    • 2022
    • 2019
    • 2018
    • 2017
    • 2016
    • 2014
  • Student theses
• Installation
  • Requirements
  • Dependencies
  • Installing from PyPI
  • Installing from source
  • Running AeoLiS
• Model description
  • Sediment Transport
  • Multi-fraction sediment transport
    • Sediment Sorting and Beach Armoring
    • Non-erodible Roughness Elements
    • Hydraulic Mixing
  • Shear velocity threshold
    • Moisture content
    • Roughness elements
    • Salt content
  • Wind shear and topographic steering
  • Vegetation
    • Shear stress reduction
    • Vegetation density
    • Growth and decay
    • Inundation
  • Surface moisture
    • Runup and wave setup
    • Tide- and wave-induced groundwater variations
    • Numerical solution of the Boussinesq groundwater equation
    • Capillary rise
    • Infiltration
    • Precipitation and evaporation
  • Sand fences
  • Marine erosion
  • Morphological change
    • Avalanching
    • Wet bed reset
• Model setup
  • Model input
    • aeolis.txt
    • x.grd
    • y.grd
    • z.grd
    • veg.grd
    • mass.txt
    • wind.txt
    • tide.txt
    • wave.txt
    • meteo.txt
  • 1D and 2D models
  • Default settings
  • Activate/deactivate processes
    • process_wind
    • process_threshold
    • process_transport
    • process_bedupdate
    • process_shear
    • process_tide
    • process_wave
    • process_runup
    • process_moist
    • process_mixtoplayer
    • process_wet_bed_reset
    • process_meteo
    • process_avalanche
    • process_separation
    • process_vegetation
    • process_fences
    • process_dune_erosion
  • Model state/output
  • Guidance on solver use
    • steadystate (default since v3)
    • trunk
    • Pieter
• Model interaction
  • Callback function
  • Hotstart
  • Basic Model Interface (BMI)
• Source code
  • Model classes
    • AeoLiS
    • AeoLiSRunner
    • WindGenerator
  • Physics modules
    • Bathymetry and bed composition
    • Wind velocity and direction
    • Wind velocity threshold
    • Tides, meteorology and soil moisture content
    • Sediment transport
    • Avalanching
    • Vegetation
    • Fences
    • Marine Erosion
  • Helper modules
    • Input/Output
    • netCDF4 output
    • Plotting
    • Command-line tools
    • Debugging
    • Miscellaneous
• References
• Appendix
  • Numerical details of solving the advection equation
    • Conservative Euler Backward Implicit (pieter solver)
    • Euler Schemes in non-conservative form (trunk solver)
    • Solving the Linear System of Equations
    • Iterations to solve for multiple fractions

Tutorials and examples

• Short courses
• Demonstration cases

Developer Documentation

• Quick start
  • Development workflow
  • Set up
    • Code Style
    • Docstrings
• Introduction to Software Testing
  • What is software testing?
  • How software tests work?
  • What are software tests?
  • Types of tests
  • Automated testing in AeoLiS
• Unit testing
  • Example: Formatting log messages
    • Test scenario
    • Test Code
• What’s New
  • v2.1.2 (July 2023)
    • Improvements
    • Bug fixes
    • Documentation
    • What’s Changed
  • v2.1.1 (March 2023)
    • Improvements
    • Bug fixes
    • Documentation
  • v2.1.0 (February 2023)
    • Breaking changes
    • Improvements
    • Bug fixes
    • Tests
  • v2.0.0 (April 2022)
    • Breaking changes
    • Improvements
  • v1.2.2 (18 April 2020)
    • Breaking changes
    • Improvements
    • New functions/methods
    • Bug fixes
    • Tests
  • v1.1.5 (unreleased)
    • Breaking changes
    • Improvements
    • New functions/methods
    • Bug fixes
    • Tests
  • v1.1.4 (15 February 2018)
    • Improvements
  • v1.1.3 (9 February 2018)
    • Bug fixes
  • v1.1.2 (21 December 2017)
    • Breaking changes
    • Improvements
    • Bug fixes
    • Tests
  • v1.1.1 (15 November 2017)
    • Improvements
    • New functions/methods
    • Bug fixes
    • Tests
  • v1.1.0 (27 July 2016)

Current Development

• Modularity
  • Suggestions for improvement
• Domain decomposition
  • Overview
  • Implementation details
  • Experiments and Results
  • Key findings
  • Reflections and To do
  • Try it yourself: Running AeoLiS in parallel mode

Contact

If you have questions about the model that is of interest to the community, please post your question in the discussion forum.

• Bart van Westen (Bart.vanWesten@deltares.nl) at Deltares

• Nick Cohn (nicholas.t.cohn@usace.army.mil) at U.S. Army Engineer Research and Development Center (ERDC)

• Sierd de Vries (Sierd.deVries@tudelft.nl) (founder) at Delft University of Technology

• Christa van IJzendoorn (vanijzec@oregonstate.edu) at Oregon State University

• Caroline Hallin (caroline.hallin@tvrl.lth.se) at Lund University

• Glenn Strypsteen (glenn.strypsteen@kuleuven.be) at Katholieke Universiteit Leuven

Acknowledgements

• AeoLiS was initially developed at Delft University of Technology with support from the ERC-Advanced Grant 291206 Nearshore Monitoring and Modeling (NEMO) and Deltares.

• AeoLiS is currently maintained by Bart van Westen at Deltares, Nick Cohn at U.S. Army Engineer Research and Development Center (ERDC) and Sierd de Vries at Delft University of Technology.

• Further development of AeoLiS is supported by the Digital Competence Centre, Delft University of Technology.

Indices and tables

• Index

• Search Page