Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openearth/aeolis-python
A process-based model for simulating supply-limited aeolian sediment transport
https://github.com/openearth/aeolis-python
Last synced: 3 months ago
JSON representation
A process-based model for simulating supply-limited aeolian sediment transport
- Host: GitHub
- URL: https://github.com/openearth/aeolis-python
- Owner: openearth
- License: gpl-3.0
- Created: 2015-12-30T11:32:38.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T15:40:43.000Z (8 months ago)
- Last Synced: 2024-03-23T05:56:56.704Z (8 months ago)
- Language: Python
- Homepage: http://aeolis.readthedocs.io/
- Size: 151 MB
- Stars: 26
- Watchers: 7
- Forks: 25
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Citation: CITATION.cff
Awesome Lists containing this project
- open-sustainable-technology - AeoLiS - Simulating aeolian sediment transport in situations where supply-limiting factors are important, like in coastal environments. (Hydrosphere / Coastal and Reefs)
README
[](http://aeolis.readthedocs.io/en/latest/)
[](https://pypi.python.org/pypi/aeolis)
[](https://pypi.python.org/pypi/aeolis)
[](https://pypi.python.org/pypi/aeolis)
[](https://pypi.python.org/pypi/aeolis)
[](https://pypi.python.org/pypi/aeolis)
[](https://zenodo.org/badge/latestdoi/7830/openearth/aeolis-python)
# 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:
```shell
pip install aeolis
```
> For Windows users, the recommend way to install AeoLiS is to use [Anaconda](https://docs.anaconda.com/free/anaconda/install/windows/).
### 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
```shell
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:
```shell
pip install -e .[dev]
```
### Running AeoLiS
Examples from command line:
```shell
aeolis run
# or wind module
aeolis wind --mean=6 --duration=3600
```
## Documentation
Detailed documentation can be found at [AeoLiS ReadTheDocs](http://aeolis.readthedocs.io/)
## AeoLiS Developer Team
The maintenance and development is done by a group of very enthusiastic people.
**Get Involved:**
Read our [Contribution Guidelines](CONTRIBUTING.md) to know how you can help to develop AeoLiS.
**Current Members:**
- [Bart van Westen](mailto:[email protected]) at Deltares
- [Nick Cohn](mailto:[email protected]) at U.S. Army Engineer Research and Development Center (ERDC)
- [Sierd de Vries](mailto:[email protected]) (founder) at Delft University of Technology
- [Christa van IJzendoorn](mailto:[email protected]) at Delft University of Technology
- [Caroline Hallin](mailto:[email protected]) at Delft University of Technology
- [Glenn Strypsteen](mailto:[email protected]) at Katholieke Universiteit Leuven
- [Janelle Skaden](mailto:[email protected]) at U.S. Army Engineer Research and Development Center (ERDC)
**Previous Members & Contributors:**
- [Bas Hoonhout](mailto:[email protected]) (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.0.rc2) [Computer software]. https://github.com/openearth/aeolis-python*
## Acknowlegdements
- AeoLiS is supported by the [Digital Competence Centre](https://dcc.tudelft.nl), Delft University of Technology.
- The contributing guidelines for AeoLiS are derived from the [NLeSC/python-template](https://github.com/NLeSC/python-template) and [numpy contributing guide](https://numpy.org/devdocs/dev/index.html#development-process-summary)
© (2023) AeoLiS Development Team, Delft, The Netherlands.