Installation

The installation process for Pingwyn is relatively straightforward. In order to be installed, you need to have at least Python 3.9 or newer, as well as the pip package manager (which comes with almost any distribution of Python).

To start, download or clone the source code of Pingwyn from the UTwente Gitlab. If you download a zip file, make sure you extract it into an easily accessable directory. Next, open a terminal or command prompt (or an Anaconda prompt if you make use of Anaconda), and move to the directory where the Pingwyn files are located. This can be achieved by using the cd command, e.g. cd Downloads/pingwyn-main. To check if you are in the right directory, you can use the ls command on Linux/Mac and the dir command on Windows. If you are in the right directory, you should see a number of directories (docs, pingwyn and tests), as well as a number of files (pyproject.toml, README.md, requirements.txt, etc.).

From this directory, install Pingwyn by running

pip install .

After this has completed, you can close the terminal window and delete the files you downloaded. You are now ready to use Pingwyn in your Python scripts.