AlgebraicJulia / AlgebraicJulia/DiagrammaticEquations.jl

Add titles to visualizations

Offen
#95 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation enhancement good first issue
Vorherrschende Sprache
Julia
Sterne
20
Forks
4
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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)

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.