To help contributors understand the structure of lowFAT, we provide a visualisation of the database model.

Updating the Model Diagram

The model visualisation is generated using Django Extensions and Graphviz.

Dependencies

You will need Graphviz installed on your machine.

On Debian or Ubuntu:

sudo apt-get install graphviz

You will also need Django Extensions installed in your development environment.

Regenerating the Diagram

To regenerate the model diagram, run:

python3 manage.py graph_models -a -g -o docs/img/models.png

The model diagram provides a high-level overview of the Django models and their relationships. Depending on the number of installed applications and historical models, the generated output may become large.