Skip to content

Latest commit

 

History

History
79 lines (63 loc) · 3.36 KB

README.md

File metadata and controls

79 lines (63 loc) · 3.36 KB
Raw

SI-Project

Introduction

A radio remote controlled robot that maps the space around it.

Exemple

python simulate.py -d 50 50 -p 25 25 -n -ani -g

Prerequisites

The Code is written in Python 3.6.5 . If you don't have Python installed you can find it here. If you are using a lower version of Python you can upgrade using the pip package, ensuring you have the latest version of pip.

To install pip run in the command Line

python -m ensurepip -- default-pip

to upgrade it

python -m pip install -- upgrade pip setuptools wheel

to upgrade Python

pip install python -- upgrade

You have to install several dependencies to get the project up and running. To do so just type

pip install requirements.txt

This will install all necessery packages

Usage

The program runs using Simulate which relies on the use of LiMap and LiSim for the simulation

  • Basic Usage python simulate.py
    Runs the Mapping procedure for one round
    • Plot and save the graphs(loss,real map, produced map, confusion matrix) at the default dir
      with python simulate.py -g
    • Add noise with python simulate.py -n
    • Animate it with python simulate.py --ani
    • Specify dimensions with python simulate.py -d 10 10
    • Specifiy position with python simulate.py -p 5 5
    • Save stats for nerds with python simulate.py -stats
    • Change saving directory to "dim,pos" python simulate.py -s
    • Save the animation in a .avi file python simulate.py -video
    • Use a weighted confusion matrix python simulate.py -rl
  • Example of advanced usage:
python simulate.py -d 50 50 -p 10 10 -n -ani -stats -g

The example above is the above command executed

Contributing

Please read CONTRIBUTING for the process for submitting pull requests.

Secuirity

Shout out to Mateo for making sure that our project has a sound secuirity policy. You will find
all the necesserary details here

Authors

  • Alexander Flammant - Initial work
  • Theodore Halley - Initial work
  • Fotios Kapotos - Initial work
  • Mateo Rivera - Initial work

This project is licensed under the MIT License - see the LICENSE.md file for details