SETS Installation Guide

Throughout this walkthrough, commands are given for Windows before and for Linux after the "slash".

Installing python

To check whether python is already installed, open a command line / terminal and enter the python --version / python3 --version command. If this command is recognized, python is already installed.

For Windows, the installer can be downloaded from the python website. During installation make sure to install python to PATH by selecting the according checkbox at the bottom of the very first window of the installer. Follow the instructions of the installer to complete the installation.

Downloads & Preperations

Once the python installation is complete, create a new folder on your PC that will contain the app. On Windows, this folder may not be a subfolder of the Downloads folder. In this walkthrough, this folder will be called SETS and is located directly on drive D:\ or your home directory ~ respectively.

From the GitHub repository, download the source code and assets by clicking on the green "CODE" button and selecting "Download ZIP". Unpack the zipped folder into your SETS folder.
Alternatively, clone the git repository by running git clone https://github.com/STOCD/SETS.git . in your SETS folder.

After this step, the files and folders from the top level of the repository should be directly in your SETS folder.

If you haven't already, open a command line or terminal. On Windows, open your SETS folder in the file explorer, type cmd in the address bar and hit Enter. Make sure, that your command line / terminal is opened in your SETS folder, showing the path to the folder (including the folder name).

Installation

Virtual Environment

It is recommended to use a python virtual environment to install the dependencies. If you prefer to install the dependecies globally, skip to the next section (Dependencies).

Create a python virtual environment using python -m venv .venv / python3 -m venv .venv. Activate the virtual environment by running .venv\Script\activate / source .venv/bin/activate. If you are using a specialized shell, please check the virtual environment documentation for further information on how to activate it. To deactivate the virtual environment, run deactivate in your command line or shell.

With a virtual environment installed, you need to activate it every time before starting the app.

Dependencies

Use the command python -m pip install . / python3 -m pip install . to install the requirements for this app. Wait for the execution to be finished, indicated by seeing the current path again at the bottom of the command line / terminal. During execution various statements will appear on the command line / terminal, which can be ignored, unless the line at the very bottom indicates an error.

Download Images

Now download the images archive from the GitHub page and unpack it. It is preferred to do that with a dedicated archiving software (like 7-zip), but operating system specific preinstalled software works as well. In your app directory create a folder named .config and put the extracted images folder into it. You can run SETS without this step, but first start can take extremely long due to thousands of images being downloaded.

Checkpoint

With this step done, your folder should have the following structure (additional files may be present):

SETS
 +- .config
 |  `- images
 |    `- <lots of images>
 +- local
 |  `- <some files>
 +- src
 |  `- <some more files>
 +- main.py
 +- pyproject.toml
 +- README.md

Starting the app

To start the app complete the following steps:

Open a command line / terminal at the location of the main.py.
If you are using a virtual environment, activate it.
Start the app by running python main.py / python3 main.py.