Skip to content

Getting started

Important

Development under windows has not been tested.

Initial project development has been performed under MacOS and Linux by the project members.

If you are developing on a windows machine, please document the required steps and submit an issue so we can update this documentation.

Requirements

  1. pip install pre-commit installs pre-commit
  2. pre-commit install hook dependencies will be automatically downloaded when hooks are first run and may take some time as they download and install.
  3. pip install poetry installs poetry
  4. install docker desktop
  5. make install Installs python virtual env and dependencies

Assumptions

  1. python and pip are already installed.
  2. make is already installed.
  3. git is already installed.