2. Installation¶

The code is written for Python 3.7+.

The following packages are needed for a minimum working installation

All packages used have OSI-approved licenses and are publicly visible.

The code is tested to run under Ubuntu, Debian, macOS, Windows, and NixOS.

2.1. Installation with pip¶

The package and all necessary dependencies can be installed with

pip install eminus

Depending on your operating system you may have to create a virtual environment. This can be done, e.g., with

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install eminus

Alternatively, you can create an installation by downloading the source code

git clone https://gitlab.com/wangenau/eminus.git
cd eminus
pip install .

To also install all optional dependencies to use built-in extras, use either

pip install eminus[all]

or for an installation after downloading the source code, use

pip install .[all]

To install only selected extras, follow the instructions given in extras.

2.2. Weekly builds¶

Weekly builds of the eminus dev branch are created every Monday morning at 08:00 (UTC) and are uploaded to the GitLab package registry. The builds use the following version scheme: version.devYYYMMDD, e.g., 3.0.0.dev20241114. To install the weekly build, use the following command

pip install eminus -U --index-url https://gitlab.com/api/v4/projects/31610189/packages/pypi/simple

-U will upgrade you to the latest eminus pre-release version, while --index-url connects you to the eminus package registry.

If the current stable version is already installed, please uninstall it before switching to weekly builds, since the stable version will be preferred when upgrading. You can uninstall eminus with

pip uninstall eminus

2.3. Docker image¶

To use a containerized version of the code, a Docker container has been created with all extras installed. The following command starts the container and a Jupyter notebook server

docker run -it -p 8888:8888 wangenau/eminus:version

Opening the displayed URL in a browser will open the Jupyter environment. Make sure to replace version with the version you want to use.

You can also pass command line arguments to the container, e.g., to start a Python environment

docker run -it wangenau/eminus:version python

2.4. Nix usage¶

To use the package under Nix one can easily create a development shell with all dependencies and (almost) all extras available. To do so, run the following commands on your Nix machine

git clone https://gitlab.com/wangenau/eminus.git
cd eminus
nix develop