Execution

We are going to explain how to install a development instance of this software and how to deploy a Docker container with the online version of this software.

Development Environment

It is highly recommended to use a Python virtual environment such as Anaconda or virtualenv to manage this project.

From inside the code folder, it is possible to install all the required packages with

pip install -r requirements.txt

Local instance

local instance of this software can be run in two different ways.

Script version

It is possible to execute the main.py script with the following command:

python main.py

Web-UI

There are different ways to run the GUI program. The simplest way is to execute the run.py script:

python web/run.py

or

python -m flask run --port 5000 --host localhost

Both commands will execute the Flask server in a local instance that is reachable at the address http://localhost:5000/.

Docker

The whole software is packaged in a Docker image. it is also possible to deploy the software using the included docker-compose file.