AlgebraicJulia / AlgebraicJulia/DiagrammaticEquations.jl

Add titles to visualizations

Ouverte
#95 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation enhancement good first issue
Langage dominant
Julia
Étoiles
20
Forks
4
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Currently, our GraphViz visualizations consist solely of diagrams of our physics alone. This is fine for REPL-driven model development, where the context is clear from the “EP” part of REPL.

However, for presentation and recording physics experiments, the interactive context in which a physics was created is lost.

So, we should document how to add titles to `to_graphviz` output, and provide helper functions

Future PRs can consider other plotting elements. We can also consider adding legends to our plots, following up on work done in PR #90 which colors components via the physics they came from.

This could be considered a step towards a more “literate” programming style, and a small step towards self-documenting physics experiments. At the extreme, we could imagine compiling a Decapodes script to a pdf documenting the physics, their composition, initial data, and plots.

![Image](https://github.com/user-attachments/assets/e860e10f-3512-4532-a96c-bbbc8570f083)

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.