Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/control parameters plotted in plot dataset #6931

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

harrietoxinst
Copy link

This PR introduces a parameters argument to the plot_dataset function such that not all dependent parameters have to be plotted if this behaviour is not desired. This closes #6898 . Motivation for this change is further outlined there.

Default behaviour of plot_dataset remains unchanged. I have also added the parameters argument to the plot_by_id function preserving the equivalent behaviour shared by plot_by_id and plot_dataset.

To provide an example of when/how this might be used I have added the following under 1.2 Two interleaved 1D sweeps in the Offline Plotting Tutorial notebook:

image

@harrietoxinst harrietoxinst requested a review from a team as a code owner March 3, 2025 13:30
@harrietoxinst
Copy link
Author

@microsoft-github-policy-service agree company="Oxford Instruments"

Copy link

codecov bot commented Mar 5, 2025

Codecov Report

Attention: Patch coverage is 18.18182% with 18 lines in your changes missing coverage. Please review.

Project coverage is 68.29%. Comparing base (003a0e5) to head (e67857d).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
src/qcodes/dataset/plotting.py 18.18% 18 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6931      +/-   ##
==========================================
- Coverage   69.39%   68.29%   -1.10%     
==========================================
  Files         341      341              
  Lines       31399    31419      +20     
==========================================
- Hits        21788    21459     -329     
- Misses       9611     9960     +349     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@harrietoxinst
Copy link
Author

Thanks for reviewing. I have committed the suggested change and fixed the errors for pre-commit check.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[feature request] option to control which parameters are plotted in plot_dataset
2 participants