Getting Started

To get this project up and running, just follow these simple steps.

Prerequisites

In order to get FlatlandASP up and running the only prerequisite is Python. To avoid conflicts with Flatland it is currently recommended to use Python 3.10.

Installation

1. Clone this repository

git clone https://github.com/VictosVertex/flatland-asp.git

2. Create a new python virtual environment (or use an existing one)

py -m venv my_new_python_environment

3. Activate the virtual environment

   Windows

   cmd.exe

   source my_new_python_environment/Scripts/activate.bat

   PowerShell

   source my_new_python_environment/Scripts/activate.ps1

   Linux

   (depending on distribution):

   bash

   source my_new_python_environment/bin/activate

4. Go into cloned repository directory

5. Install the project as an editable package

pip install -e .

The project is now ready to be used in any project using the python virtual environment.