VerifiableRobotics / LTLMoPWeb3D

A website for Cornell's Autonomous Systems Lab to essentially have LTLMoP available in 3D and online
https://ltlmop.herokuapp.com/
Other
3 stars 1 forks source link

Table of Contents

I. Check out the live version!
II. See the Wiki for examples and miscellaneous instructions
III. See the Overview for the rationale behind this project
IV. Installation
V. Development
VI. Working on Front End
VII. Deployment

LTLMoP API

The LTLMoP API is a mostly complete file-based API to which one can pass a spec and regions for compilation and returns the compiler log. Via few simple URLs (and a unique session token [or API key]), one can access all the compiled artifacts: the automaton (/saveAut), the decomposed regions (/saveDecomposed), the LTL (/saveLTL), the SMV (/saveSMV), and a new spec file with a mapping from the original regions to ther decomposed counterparts (/saveSpec).

It also currently serves LTLMoPWeb3D, the web front end to the LTLMoP API.

Installation

Prerequisites

  1. Install Git
  2. Install Vagrant

Getting Started

  1. Clone this repo
  2. Change directories to the repo
  3. vagrant up will create a VM with all dependencies AND run the services
  4. Connect to http://192.168.33.10:5000

Development

  1. vagrant up to start the already created and provisioned VM
  2. vagrant ssh will SSH you into the VM
  3. Change directories into the the shared older (see Vagrantfile)
  4. docker-compose up -d will run the API in the background in debug and watch mode
  5. Connect to http://192.168.33.10:5000

Further Reading

  1. Vagrant Docs
  2. Docker Docs
    • Read the Engine and Compose CLIs