Table of Contents

1. About The Project
2. Tools
3. Prerequisites
4. Installation and compilation
5. Usage

About The Project

This project has been developped during the second semester at EPFL by Ferrulli Massimiliano and Carl Johan Waldorff. It consists in a 2D simulation of an aquatic microsystem written entirely in C++. The system is composed by algae (green dots), scavengers (red circles) and corals (blue segment).

Tools

Those are the tools we used:

• C++ 11
• Gtkmm 4.0
• Makefile
• Git
• Liveshare
• Latex

Prerequisites

In order to use this project you have to install gtkmm 4.0

• Linux (pacman):

  sudo pacman -S gtkmm-4.0
  

Installation and compilation

1. Clone the repo

   git clone https://github.com/MassimilianoCEZ/MicroReef
   

2. Change directory

   cd Microreef
   

3. Compiling

   make 
   

Usage

after compiling you can launch the project via:

./projet 

or you can launch it directly with an opened file (replace the XX with the actual number of the test file):

./projet TESTfiles/tXX.txt 

Once the GUI is opened you will find on the left 5 buttons.

• The open button is used to initialize the simulation by opening a .txt file and overwriting the current one.
• The save button is used to save all the infos of the current status of the simulation, giving the user the possibility to reopen it later.
• The start button will start the simulation and once pressed becomes a stop button.
• The step button does only one update on the simulation. On the left is also present a check box called "Birth of algae" that will let spawn the algae randomly in the world every update. the number of updates and the number of entities for each type is updated and show in the left.

(back to top)