A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

AeoLiS

Simulating aeolian sediment transport in situations where supply-limiting factors are important, like in coastal environments.
https://github.com/openearth/aeolis-python

Category: Hydrosphere
Sub Category: Coastal and Reefs

Last synced: about 2 hours ago
JSON representation

Repository metadata

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

README.md

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.0.rc2) [Computer software]. https://github.com/openearth/aeolis-python

Acknowlegdements

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

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: AeoLiS
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
contact:
  - affiliation: AeoLis Development Team
    email: [email protected]
    family-names: Sierd
    given-names: de Vries
authors:
  - given-names: Sierd
    name-particle: de
    family-names: Vries
    affiliation: Delft University of Technology
    email: [email protected]
    orcid: 'https://orcid.org/0000-0001-5865-3715'
  - given-names: Caroline
    family-names: Hallin
    email: [email protected]
    affiliation: Lund University (Division of Water Resources Engineering)
    orcid: 'https://orcid.org/0000-0001-9921-5754'
  - given-names: Christa
    name-particle: van
    family-names: IJzendoorn
    email: [email protected]
    affiliation: Delft University of Technology
    orcid: 'https://orcid.org/0000-0001-9756-1856'
  - given-names: Bart
    name-particle: van
    family-names: Westen
    affiliation: Delft University of Technology
    orcid: 'https://orcid.org/0000-0001-7903-6062'
  - given-names: Nicholas
    family-names: Cohn
    email: [email protected]
    affiliation: US Army Engineer Research and Development Center
    orcid: 'https://orcid.org/0000-0003-4287-039X'
  - given-names: Glen
    family-names: Strypsteen
    email: [email protected]
    affiliation: Katholieke Universiteit Leuven
    orcid: 'https://orcid.org/0000-0002-0078-7259'
  - given-names: Janelle
    family-names: Skaden
    email: [email protected]
    affiliation: US Army Engineer Research and Development Center
    orcid: ''
  - given-names: Niket
    family-names: Agrawal
    email: [email protected]
    affiliation: Delft University of Technology
    orcid: 'https://orcid.org/0000-0002-3208-3440'
  - given-names: Manuel
    family-names: Garcia Alvarez
    email: [email protected]
    affiliation: Delft University of Technology
    orcid: 'https://orcid.org/0000-0003-1579-9989'
repository-code: 'https://github.com/openearth/aeolis-python'
url: 'https://aeolis.readthedocs.io/'
abstract: AeoLiS is a process-based model for simulating aeolian sediment transport in situations where supply-limiting factors are important, like in costal environments. 
keywords:
  - python
  - simulation
  - sediment
license: GPL-3.0
commit: 0adaedfc8015f18b3b551bed1dda38d630cd8c95
version: 3.0.0.rc3
date-released: '2023-10-18'

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 5 days ago

Total Commits: 721
Total Committers: 13
Avg Commits per committer: 55.462
Development Distribution Score (DDS): 0.789

Commits in past year: 18
Committers in past year: 5
Avg Commits per committer in past year: 3.6
Development Distribution Score (DDS) in past year: 0.556

Name Email Commits
Sierd s****s@t****l 152
Bas Hoonhout b****s@h****m 121
Manuel G. Garcia g****2@g****m 117
bartvanwesten b****w@l****l 79
Nick Cohn n****n@g****m 61
Bas Hoonhout b****t@d****l 58
CarolineHalllin c****n@t****e 56
Niket 1****l 25
tomspak t****k@t****l 21
christavanijzendoorn c****n@g****m 14
Nellskaden 6****n 9
GlennStrypsteen g****n@k****e 7
Bas Hoonhout h****t@B****x 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 106
Total pull requests: 75
Average time to close issues: 2 months
Average time to close pull requests: 20 days
Total issue authors: 14
Total pull request authors: 7
Average comments per issue: 1.01
Average comments per pull request: 0.59
Merged pull request: 63
Bot issues: 0
Bot pull requests: 0

Past year issues: 33
Past year pull requests: 27
Past year average time to close issues: 20 days
Past year average time to close pull requests: 4 days
Past year issue authors: 11
Past year pull request authors: 6
Past year average comments per issue: 0.33
Past year average comments per pull request: 0.7
Past year merged pull request: 20
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/openearth/aeolis-python

Top Issue Authors

  • manuGil (28)
  • Sierd (20)
  • niketagrawal (17)
  • bartvanwesten (12)
  • CarolineHalllin (5)
  • christavanijzendoorn (5)
  • GlennStrypsteen (5)
  • maddykelley (4)
  • frederikvand (3)
  • Jan-MarkusHomberger (2)
  • mwengrove (2)
  • QuentinLf (1)
  • saeb-faraji-gargari (1)
  • lzhu5 (1)

Top Pull Request Authors

  • manuGil (27)
  • Sierd (12)
  • niketagrawal (10)
  • bartvanwesten (10)
  • CarolineHalllin (6)
  • christavanijzendoorn (6)
  • GlennStrypsteen (4)

Top Issue Labels

  • documentation (19)
  • enhancement (17)
  • bug (14)
  • question (14)
  • test (10)
  • refactoring (7)
  • help wanted (3)
  • wontfix (2)

Top Pull Request Labels

  • documentation (16)
  • bug (6)
  • enhancement (4)
  • test (3)
  • refactoring (1)

Dependencies

docs/requirements.txt pypi
  • AeoLiS ==2.0.0.dev2
  • sphinxcontrib-bibtex <2.0.0
  • sphinxcontrib-napoleon *
requirements.txt pypi
  • bmi-python *
  • codecov *
  • coverage *
  • ipykernel *
  • matplotlib *
  • netCDF4 *
  • nose *
  • scipy *
setup.py pypi
  • bmi-python *
  • docopt ==0.6.1
  • matplotlib *
  • netCDF4 *
  • numpy *
  • scipy *

Score: 7.139660335964919