2. Installation¶
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. 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.3. 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