Skip to content

Latest commit

 

History

History
108 lines (72 loc) · 6.46 KB

README.md

File metadata and controls

108 lines (72 loc) · 6.46 KB

Flatland ASP

Flatland ASP deals with the application of Answer Set Programming techniques to the Flatland environment.

Its first goal is to provide a short introduction to Flatland as well as to Answer Set Programming, more precisely Clingo, with the help of documentation and examples.

The second and more exciting goal is to explore various ASP instantiations and encodings of the Flatland environment in order to find solutions to the problems Flatland tries to help to solve.

For any information that goes beyond this README, please visit the FlatlandASP Wiki or refer to the Link section

Table of Contents
  1. Getting Started
    1. Prerequisites
    2. Installation
  2. General Project Structure
  3. Links

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
  1. Create a new python virtual environment (or use an existing one)
py -m venv my_new_python_environment

  1. 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

  2. Go into cloned repository directory

  3. 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.

back to top

General Project Structure

  • data/
    • data/encodings/ ASP encodings
    • data/environments/ Environment data (.json) and environments (.pkl)
  • examples/ Examples for Flatland and ASP (Clingo)
  • src/flatlandasp
    • src/flatlandasp/core/flatland Flatland related classes, schemas, mappings, static maps, etc.
    • src/flatlandasp/core/asp ASP/Clingo related instance descriptions, generators, etc.
    • src/flatlandasp/core/utils Utility functions for files, images, etc.
    • src/flatlandasp/features/ Modular features building on core/each other, API endpoints

Links

Useful links for more information on Flatland and Clingo

back to top