trixi-framework/Trixi.jl

Make axis labels created by `PlotDataXD` objects more flexible

Open

#590 geöffnet am 22. Mai 2021

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (686 Stars) (153 Forks)batch import
enhancementgood first issuevisualization

Beschreibung

Right now, axis labels for plotting with Plots.jl are automatically determined to be x, y, or z (see _get_dimensions and _get_guides in src/visualization/plot_recipes.jl). This precludes using PlotData1D from using it conveniently for something like TimeSeriesCallback results.

A possible approach would be to store the axis labels with the PlotDataXD objects depending on from which data source they were created, instead of determining the labels on the fly at plot time.

Contributor Guide

Tech Stack
Keine
Domain
data
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Julia knowledgeTrixi.jl basicsPlots.jl experience
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45
Research-Richtung
Investigate the current implementation in `src/visualization/plot recipes.jl` specifically the ` get dimensions` and ` get guides` functions. Understand how axis labels are currently determined from PlotDataXD objects. Then explore modifying the PlotDataXD constructors to store custom axis labels based on the data source. Consider adding tests for the new flexibility.