trixi-framework/Trixi.jl

Make axis labels created by `PlotDataXD` objects more flexible

Open

#590 opened on May 22, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (686 stars) (153 forks)batch import
enhancementgood first issuevisualization

Description

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
None
Domain
data
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Julia knowledgeTrixi.jl basicsPlots.jl experience
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
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.
Make axis labels created by `PlotDataXD` objects more flexible · trixi-framework/Trixi.jl#590 | Good First Issue