Installation

Installation#

The recommended method of installation for most users is via pip.

Install with pip and venv#

In order to install Fesslix using pip inside a virtual environment of Python, please follow the steps outlined in the following.

Step 1) Make sure Python is installed#

As Fesslix is a Python module, you must have Python installed.

Python comes preinstalled on most Linux distributions, and is available as a package on all others.

Please download and install Python.

Install a recent version of Python; e.g., using Homebrew:

# If you have not already installed Homebrew, install it:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
# Use Homebrew to install Python:
brew install python

To update Python, run:

brew update
brew upgrade python

Step 2) Create a virtual environment in Python#

python -m venv ~/.venv-fesslix

py -m venv C:\path\to\new\virtual\environment\venv-fesslix

python3 -m venv ~/venv-fesslix

Step 3) Activate the virtual environment#

source ~/.venv-fesslix/bin/activate

path\to\new\virtual\environment\venv-fesslix\Scripts\activate

source ~/venv-fesslix/bin/activate

Important

Whenever you want to work with Fesslix, you need to activate the virtual environment before starting Python.

Step 4) Install Fesslix as Python module#

pip install fesslix

py -m pip install fesslix

pip install fesslix

Verifying the Installation#

After installing NumPy, verify the installation by running the following commands in a Python shell or script:

import fesslix as flx
print(flx.__version__)

This should print the installed version of Fesslix without errors.

Keeping Fesslix up to date#

pip install --upgrade fesslix

py -m pip install --upgrade fesslix

pip install --upgrade fesslix

Install as a local build#

new installation#

Follow Step 1, Step 2 and Step 3 in section Install with pip and venv.

Fetch the source code:

git clone https://github.com/fesslix/fesslix.git
cd fesslix

Trigger the local build:

pip install . -v

updating an existing installation#

To update an existing local build, change into the source directory of Fesslix and execute the following commands:

git pull
pip install . -v

compile in debug mode#

git pull
pip install . -v --config-settings=cmake.build-type="Debug" --config-settings=cmake.args=-DFLX_DEBUG=ON
Contents