Installation

Prerequisites

The package requires Python >= 3.12. To install required system packages on Ubuntu/Debian based systems run:

sudo apt-get update
sudo apt-get install python3 python3-venv python3-pip python-is-python3 git

or on MacOS

brew install python3

Python Virtual Environment

For installing the multiphasepy package, create a Python virtual environment:

python -m venv <PATH/TO/VENV>

If you wish to make Python packages available in the environment that are installed system-wide, create the environment with the additional option --system-site-packages:

python -m venv --system-site-packages <PATH/TO/VENV>

Activate Environment

Environments are activated by:

. <PATH/TO/VENV>/bin/activate

and deactivated by:

deactivate

Install from GitLab PyPI

The multiphasepy package is installed via pip from the Gitlab PyPi. For a simple and convenient usage add the following to $HOME/.config/pip/pip.conf:

[global]
extra-index-url = https://codebase.helmholtz.cloud/api/v4/projects/8786/packages/pypi/simple

With the environment activated, install the package with:

pip install multiphasepy

or upgrade with:

pip install --upgrade multiphasepy

Install from Source

Clone the repository and install in development mode:

git clone https://codebase.helmholtz.cloud/fwdc/python.git
cd python
pip install -e .

Optional Dependencies

For development, testing, and documentation install the development dependencies. Please look into pyproject.toml for more information on the installed packages:

pip install multiphasepy[dev]