README.md

EvacuationPy

Prerequisites

1. Python 3.8 or above
2. pip 23.1.2 or above (to upgrade pip run python -m pip install --upgrade pip)

project setup

1. clone this repository
2. pip install .[all] - install dependencies for developing
3. pre-commit install - setup pre commit hooks

tests

to run tests execute pytest -n logical in your terminal

code linting

to lint code with ruff execute ruff check . in your terminal
to lint code with black execute black --check . in your terminal