Catalog PyPI
Back to packageRELEASE DETAILS

3.0.1

PyPI

aeolis

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

aeoliandeltaresmodelsedimenttransporttudelft
Published11 Jul 2025
Direct dependencies16
Transitive dependenciesNot calculated

README

Version 3.0.1 documentation

AeoLiS Banner

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.

https://github.com/openearth/aeolis-python/assets/14054272/128684d6-73ac-4a5f-a186-51559679bd66

Installation

Requirements:

  • Python 3.9 or newer
  • pip 22.0 or newer
  • netCDF4

Installing from PyPI

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

pip install aeolis

For Windows users, the recommend way to install AeoLiS is to use Anaconda.

Installing from source

  1. Clone the repository using Git, or download the source code.

  2. AeoLiS users may install the package with only the required dependencies. Go to aeolis-python directory and install using pip

    cd aeolis-python/
    pip install .
    
  3. AeoLiS users who intend to modify the sourcecode can install additional dependencies for test and documentation as follows. Go to root directory aeolis-python/ and:

    pip install -e .[dev]
    

Running AeoLiS

Examples from command line:

aeolis run <path/to/aeolis.txt/>
# or wind module
aeolis wind <path/to/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:

de Vries, S., Hallin, C., van IJzendoorn, C., van Westen, B., Cohn, N., Strypsteen, G., Skaden, J., Agrawal, N., & Garcia Alvarez, M. (2023). AeoLiS (Version 3.0.1) [Computer software]. https://github.com/openearth/aeolis-python

Acknowlegdements

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

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 16

Native requirements
16 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
bmi-python
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
bmi-pythonruntime
docopt
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
docoptruntime
matplotlib
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
matplotlibruntime
netcdf4
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
netcdf4runtime
numba
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
numbaruntime
numpy
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
numpyruntime
scipy
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
scipyruntime
typer
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
typerruntime
nbsphinx
Environment
{
  "extras": "",
  "marker": "extra == \"dev\"",
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
nbsphinx>=0.9.2; extra == "dev"runtime
plot
Environment
{
  "extras": "",
  "marker": "extra == \"dev\"",
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
plot==0.6.5; extra == "dev"runtime
pytest
Environment
{
  "extras": "",
  "marker": "extra == \"dev\"",
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
pytest; extra == "dev"runtime
pytest-cov
Environment
{
  "extras": "",
  "marker": "extra == \"dev\"",
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
pytest-cov; extra == "dev"runtime
sphinx-copybutton
Environment
{
  "extras": "",
  "marker": "extra == \"dev\"",
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
sphinx-copybutton==0.5.2; extra == "dev"runtime
sphinx-rtd-theme
Environment
{
  "extras": "",
  "marker": "extra == \"dev\"",
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
sphinx-rtd-theme; extra == "dev"runtime
sphinx
Environment
{
  "extras": "",
  "marker": "extra == \"dev\"",
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
sphinx<7; extra == "dev"runtime
sphinxcontrib-bibtex
Environment
{
  "extras": "",
  "marker": "extra == \"dev\"",
  "requires_python": "<4,>=3.9",
  "evaluation": "NOT_EVALUATED"
}
sphinxcontrib-bibtex>=2.5.0; extra == "dev"runtime

Distribution files

2 collected
aeolis-3.0.1-py3-none-any.whl

bdist_wheel · 42,710.01 KB · Python py3

Source file
aeolis-3.0.1.tar.gz

sdist · 41,450 KB · Python source

Source file

Repository

PENDING
openearth/aeolis-python

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 20:24 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:bf4bb5a433b55dd5af39783cea591a475cb93c078f58ed9bcdc07c4fb58c4237

Other collected versions

View all collected versions →