Feature/enhanced waveform report

[KevinAVR]

Summary

Integrate the enhanced waveform report into qualang_tools as the new qualang_tools.waveform_report subpackage (Alternative 1 from the plan).

What was implemented:

• New subpackage qualang_tools/waveform_report/ with __init__.py re-exporting the public API and enhanced_report.py containing the implementation.
• Public API: VerticalMarkerConfig, TimingMarker, create_waveform_plot_with_markers, extract_timing_markers.
• waveform_report added to qualang_tools.__all__.
• Tests moved to tests/waveform_report/test_enhanced_waveform_report.py with imports updated to qualang_tools.waveform_report.
• Code formatted with black (modified files only). CHANGELOG.md updated.

NOTE: Black got into the way of a few test files, but run all the regressions in the repository and passed. These are the important ones

Checklist:

• CHANGELOG.md updated
• Tests added in tests/waveform_report/

[github-actions]

Unit Test Results

0 tests   0 ✔️  0s ⏱️
0 suites  0 💤
0 files    0 ❌

Results for commit c2b4765.

♻️ This comment has been updated with latest results.

[KevinAVR]

@OziEgri and @deanpoulos I lost access to my VPN but I will add here qua-programs files that can be run as a test with the simulator that you could run automatically as well as I will attach the enhanced waveform report

[yomach]

With not just create_waveform_plot?

[yomach]

I have many thoughts.
I was always in favor of moving the plotting to qualang_tools. But I don't want two tools, and I don't like the name enhanced waveform report.
We are one company, we need one product.
Let's name it Waveform Report and just improve it!

[KevinAVR]

I have many thoughts. I was always in favor of moving the plotting to qualang_tools. But I don't want two tools, and I don't like the name enhanced waveform report. We are one company, we need one product. Let's name it Waveform Report and just improve it!

Hi @yomach I got some what you meant, a unified waveform report. Which one did you mean in terms of single + improve?

• move waveform report to qualang tools altogether?
• take it out of the SDK? what is the process for that
• revamp it completely or build it with a scaffold?
• or something else?

[yomach]

@KevinAVR - Good questions.
I've talked with Ozi & Natan, we need to decide on that, and then they'll address this PR.