Skip to content

Installation guide

Lorenzo Mentaschi edited this page Mar 26, 2024 · 37 revisions

alphaBetaLab comes as a python3 library, and can be used in any operating system fully supported by python (e.g. Linux, MacOSX, Windows). Running alphaBetaLab on large domains can be computationally expensive, and the required time can be significantly reduced by running parallel. It is therefore preferable to install it on multicore workstations.

It is possible to download the source code of alphaBetaLab version 1.0.0 form the site https://github.com/menta78/alphaBetaLab/releases.

To run alphaBetaLab, it is necessary to install it in python3 as a library. The easiest way to accomplish this is using miniconda, a custom installation of python, independent from the one installed in the operating system.

The installation process illustrated below has been tested on Linux Ubuntu and Linux CentOS. It should work in any unix-like OS supported by miniconda, like macOS. In Windows, alphaBetaLab can be installed using the very same instructions used here on the Windows Subsystem for Linux (WSL) system.

A suggested way to install alphaBetaLab is via miniconda, a distribution of Python for scientific computing and data science. The miniconda installer that was tested here can be downloaded from https://repo.anaconda.com/miniconda/Miniconda3-py39_23.11.0-2-Linux-x86_64.sh .

Once miniconda is installed, for example in /myminiconda, we need to install a few dependencies. We can accomplish this with the command

$ /myminiconda/bin/conda install -c conda-forge shapely=2.0.1 matplotlib=3.5.3 netcdf4=1.6.0 scipy=1.9.1 cartopy=0.21.1 pandas=1.4.3 fiona=1.9.1

Assuming that we unzipped alphaBetaLab in /home/myuser/src/alphaBetaLab, we can verify that the dependencies are correctly installed with these commands:

$ cd /home/myuser/src/alphaBetaLab/; /myminiconda/bin/python -m unittest test.testAbIntegrity

The test should run for some time, and if the setup of python is correct the final line of the standard output should be “OK”. Now we are ready to install alphaBetaLab:

$ cd /home/myuser/src/alphaBetaLab/; /myminiconda/bin/python setup.py install

For the interested reader, the command to launch all the tests is

$ cd /home/myuser/src/alphaBetaLab/; /myminiconda/bin/python -m unittest discover

Clone this wiki locally