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 (153 forks)batch import
enhancementgood first issuevisualization

Repository metrics

Stars
 (686 stars)
PR merge metrics
 (Avg merge 9d 1h) (37 merged PRs in 30d)

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

Research direction
Store axis labels as fields in PlotData1D/PlotData2D/PlotData3D objects when they are created from data sources like TimeSeriesCallback, instead of inferring them from dimension names at plot time.
Tech stack
None
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JuliaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70