For a detailed description of how to use the instance generator and the theory behind it, we refer to the corresponding paper: https://doi.org/10.48550/arXiv.2507.03423
The project is written in Python and uses a Django web server. This version of the instance generator currently does not work on Windows, and we recommend using a Mac or Linux operating system. You need to install all required python packages. It is recommended to use a virtual environment for that. Follow the steps:
- Install a current python version, if it is not already the case (python3 is pre-installed on MacOS and many Linux distributions).
- Using the terminal, enter the directory of the project.
- Create a virtual environment, for example using venv, by running
python3 -m venv .venv. This creates a virtual environment in a .venv folder. - Activate the virtual environment via
source .venv/bin/activate. In case you want to leave the virtual environment after using the project, you can type indeactivate. - Now, install all requirements (within the virtual environment):
pip install -r website/requirements.txt - If it is the first time, execute
python website/manage.py migrateto ensure that the data base functions properly. - Start the Django server by
python website/manage.py runserver. This may take a while doing it the first time. - You can now reach the Instance Generator through a browser by opening
http://127.0.0.1:8000/.