scipp/plopp

Add a new `residuals_plot`?

Open

#201 opened on Apr 13, 2023

View on GitHubContributor guide
 (14 comments) (0 reactions) (0 assignees)Python (6 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (11 stars)
PR merge metrics
 (PR metrics pending)

Description

This example shows how to make a plot of multiple lines with a residual difference panel below the main plot.

Is this something that is common enough that we could have a dedicated function for creating it? For example, plopp.residual_plot(b, c, reference=a) would show 3 lines in the main panel and b-a and c-a in the residuals panel.

I guess it would be most useful if it could be used as a view in a graph of nodes, and not just a single purpose function. This would mean that it could be used in combination with a slider, where both the main panel and the residuals would update when moving the slider.

Contributor guide

Research direction
Inspect the existing example for plotting multiple lines with a residual panel, and study how plopp's plotting functions and node views are implemented. Explore how to create a new function that returns a view incorporating the residual differences, and how to integrate it with a graph of nodes for interactivity.
Tech stack
python
Domain
data visualization
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45