python 3, pip

Used IDE: vscode, plugin python

pipenv easy the process of managing python dependencies

PIP

$ pip install pyenv

Alternatively, macOS brew

$ brew install pipenv 

Inside the project folder (after clone)

$ pyenv install 3.8.2
$ pip install pipenv
$ pipenv install
$ pipenv shell
(gmrs env) % pipenv install --dev

Select the exec shell

$ pipenv shell

Then, Execute Simulation

$ python ./simulator/run.py

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

 $ pytest -v --cov .

 $ flake8 --statistics

To add new dependencies use the following command.

$ pipenv install [name]

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

Same as previous dependencies, but for development libraries such as the ones used for test.

$ pipenv install [name] --dev

Note that other systems after pulling updates will need a reexecution of pipenv install --dev