Installation

AeoLiS is a Python package that can be installed from PyPI or from source. For the source code, see the GitHub repository.

Requirements

  • Python 3.8 or newer

  • pip 22.0 or newer

  • netCDF4

Dependencies

  • docopt==0.6.1

  • bmi-python

  • netCDF4

  • scipy

  • numpy<1.24,>=1.18

  • matplotlib

  • numba

Installing from PyPI

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

pip install aeolis

Attention

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. Go to the aeolis-python directory and install using pip

    cd aeolis-python/
pip install .

Running AeoLiS

Example from command line:

aeolis params.txt

Note

Model parameters and other configuration is passed in a params.txt. See the Default settings for more details.