smart-pucrs / MASiRe

MASiRe — MAS in Response

This is the source code of a Multi-agent System simulator designed for coping with disaster response episodes. This simulator is inspired by the Multi-Agent Programming Contest (MAPC) and was initially developed by a team of students of AGES at PUCRS. For more information about this project we refer to our wiki.

Table of Contents

• Prepare the Environment
• Run the Disaster Simulator
• Testing
• Contributing to this Project

Prepare the Environment

In order to execute our simulator you need to have Python 3.6 installed on your machine and a configuration file like the one on the files folder (one can use that for tests).

# Clone this repository
$ git clone https://github.com/smart-pucrs/MASiRe.git

# Access the project folder in the terminal/cmd
$ cd MASiRe

# Install the dependencies
$ pip3 install -r requirements.txt

Run the Disaster Simulator

After having the environment configured, you can run the simulation in a terminal at the root of this project directory, just type the following command in the terminal:

python3 start_system.py <configuration-file>.json

Note: Do not use the "<" or ">", it was just to highlight that it is the desired configuration file. Also, the path to the configuration file is considered to be from the root of the project, so if one wants to use the configuration file inside the files folder, one should pass to the simulation "files/config.json". If you want, you can use the default configuration, in this case just pass "config/default_config.json".

Testing

If you want to check if everything is working you can use the pytest framework. If you have Visual Studio Code you can do this via the test option in the left menu. But if you are coding in another text editor, you need to type the following comand in the terminal/cmd:

python3 -m pytest src/tests/unity

Contributing to this Project

João Gabriel Dourado Cervo

João Vitor Bernardi Severo

Tabajara Krausburg Rodrigues

Vinicius Chrisosthemos Teixeira

Rafael H. Bordini