Metadata-Version: 2.1
Name: hmrs-mission-control
Version: 1.0.2
Summary: **Heterogeneous Multi-Robots Mission Control** is an architecture for the development of applications, capable of coordinating multi-robot missions subject to uncertainty in properties of the available robots in the Software Engineering Lab (LES) at University of Brasilia.
License: MIT
Author: Gabriel Rodrigues
Author-email: gabrielsr@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: PyQt5 (>=5.15.6,<6.0.0)
Requires-Dist: jsonpickle (>=2.2.0,<3.0.0)
Requires-Dist: lagom (>=1.7.0,<2.0.0)
Requires-Dist: lxml (>=4.8.0,<5.0.0)
Requires-Dist: matplotlib (>=3.5.2,<4.0.0)
Requires-Dist: setuptools (>=62.3.2,<63.0.0)
Requires-Dist: shortuuid (>=1.0.9,<2.0.0)
Project-URL: Bug Tracker, https://github.com/lesunb/hmrs_mission_control/issues
Description-Content-Type: text/markdown

[![Build Status](https://www.travis-ci.com/gabrielsr/hmrs_mission_control.svg?branch=master)](https://www.travis-ci.com/gabrielsr/hmrs_mission_control)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/c40a1b3e88c74755be3423074b0b0b45)](https://www.codacy.com/gh/gabrielsr/hmrs_mission_control/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=gabrielsr/hmrs_mission_control&amp;utm_campaign=Badge_Grade)
[![codecov](https://codecov.io/gh/gabrielsr/hmrs_mission_control/branch/master/graph/badge.svg)](https://codecov.io/gh/gabrielsr/hmrs_mission_control)



Heterogeneous Multi-Robots Mission Control
==========================================

## Overview

**Heterogeneous Multi-Robots Mission Control** is an architecture for the development of applications, capable of coordinating multi-robot missions subject to uncertainty in properties of the available robots in the Software Engineering Lab (LES) at University of Brasilia.

**Keywords:** Software architecture, cooperative heterogeneous robots, multi-robots systems, Cyber-physical systems

### License

The source code is released under a [MIT license](LICENSE).

**Authors: Gabriel Rodrigues, Vicente Moraes and Gabriel F P Araujo <br />
Affiliation: [LES](http://les.unb.br//)<br />
Maintainers: [Gabriel Rodrigues](mailto:gabrielsr@gmail.com), [Vicente Moraes](mailto:vicenteromeiromoraes@gmail.com),[Gabriel F P Araujo](mailto:gabriel.fp.araujo@gmail.com)**

**Heterogeneous Multi-Robots Mission Control** is research code, expect that it changes often and any fitness for a particular purpose is disclaimed.

Environment dependencies
-------------
python 3, pip

Used IDE: vscode, plugin python

macOS aditional dependencies
brew install libmagic

Development
---

Install poetry
------------- 

poetry easy the process of managing python dependencies

PIP
```console
$ pip install poetry
```

Alternatively, macOS brew
```console
$ brew install poetry 
```

Install dependencies
--------------------

Inside the project folder (after clone)

```console
$ poetry install
$ poetry shell
```

Run a Controlled Experiment
------
Inside poetry environment (after poetry shell)

```console
 python evaluation/experiment_gen_lab_samples/experiment_gen.py
```


Test
----

Tests should be put on /tests folder and are executed with the following command.

```console
 $ poetry run pytest -v --cov .
```

Linter
------

```console
 $ flake8 --statistics
```


Run
---

Select the exec shell

```console
$ poetry shell
```

Then, Execute Simulation

```console
$ python ./run.py
```

Dependency
----------

Add New Dependency
------------------

To add new dependencies use the following command.

```console
$ poetry install [name]
```

This command will add the dependency to the Pipfile and poetry.lock assuring that the execution can be reproduced in another environment (after dependencies are updated with `poetry install` command )

Add New Dev Dependency
----------------------
Same as previous dependencies, but for development libraries such as the ones used for test.

```console
$ poetry install [name] --dev
```
Note that other systems after pulling updates will need a reexecution of `poetry install --dev`

