Getting Started#

This short guide will walk you through the required steps to set up and install fours.

Attention

The code was written for Python 3.8 and above

Installation#

The code of fours is available on GitHub. We strongly recommend you to use a virtual environment to install the package.

Just run:

pip install fours

Start by cloning the repository and install fours as a Python package:

git clone git@github.com:markusbonse/fours.git ;
cd fours ;
pip install .

In case you intend to modify the package you can install the package in “edit mode” by using the -e flag:

pip install -e .

Depending on the use case fours can be installed with additional options. If you install fours from GitHub you can add them by:

pip install -e ".[option1,option2,...]"

The following options are available:

dev: Adds all dependencies needed to build this documentation page with sphinx.
plotting: Installs the libraries seaborn, matplotlib and bokeh which we use in our plots.