Skip to content

A process-based model for simulating supply-limited aeolian sediment transport

License

Notifications You must be signed in to change notification settings

CarolineHalllin/aeolis-python

 
 

Repository files navigation

AeoLiS Banner

Codecov ReadTheDocs PyPI PyPI_versions PyPI_status PyPI_format License DOI

AeoLiS

AeoLiS is a process-based model for simulating aeolian sediment transport in situations where supply-limiting factors are important, like in coastal environments. Supply-limitations currently supported are soil moisture contents, sediment sorting and armouring, bed slope effects, air humidity and roughness elements.

Installation

Requirements:

  • Python 3.8 or higher
  • Setuptools
  • pip

Installing from PyPI

On the comand line of your working environment (Bash/Shell, Conda, Mamba, or similar), run the following:

pip install AeoLiS

Installing from source

  1. Clone the repository (AEOLIS_V2 branch) using git, or download the source code.

  2. Go to the aeolis-python directory and install using pip

    cd aeolis-python/
    pip install .

Running AeoLiS

Example from command line:

aeolis params.txt
aeolis-wind wind.txt --mean=6 --duration=3600

Documentation

Detailed documentation can be found at AeoLiS ReadTheDocs

AeoLiS Developer Team

The maintenance and development is done by a group of very enthusiastic people.

Get Involved: Read our Contribution Guidelines to know how you can help to develop AeoLiS.

Current Members:

Previous Members & Contributors:

  • Bas Hoonhout (founder)
  • Tom Pak
  • Pieter Rauwoens
  • Lisa Meijer

Citation

Please, cite this software as follows:

AeoLiS Development Team. AeoLiS (Version 2.1.1) [Computer software].

Acknowlegdements

© (2023) AeoLiS Development Team, Delft, The Netherlands.

About

A process-based model for simulating supply-limited aeolian sediment transport

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%