Set Up Environment

Follow these steps to set up a development environment.

Requirements

  • Python >= 3.11

  • Recent version of PIP

  1. Clone the repository:

git clone git@github.com:Illuminator-team/Illuminator.git
  1. Go the root tof the repository:

cd Illuminator/
  1. install the development dependencies in editable mode:

pip install -e .

Running Unit Tests

We use Pytest to write and test the source code. To run all unit-tests, run the following command at the root of the repository:

pytest tests/