Diagram Creation

UML diagrams

plantuml is used to create UML diagrams

Architecture diagrams

Diagrams-as-Code tools are used to generate the images of design diagrams from python code.

To run the code to generate a diagram, you only need the diagrams depedency.

Quickstart

Create a virtual environment, install dependency, and create diagrams!

python -m venv env
source env/bin/activate
pip install diagrams
cd hpc_only/
python HPC.py

Automated diagram creation on commit

There is a pre-commit hook at the top-level directory of the project that automatically will generate the latest diagrams, called .pre-commit-config.yaml to sync the code and diagrams.