Skip to content

Conversation

@Kyung-hoon-Jung0
Copy link
Collaborator

Summary

This PR focuses solely on pre-commit (pylint/black) compliance for the Ramsey calibration files.

  • No functional or behavioral changes
  • Added missing docstrings for modules, classes, and functions
  • Fixed import order, line length, and code style issues
  • Goal: ensure clean pre-commit passes

File-by-file summary of changes (non-functional only)

calibration_utils/ramsey/__init__.py
  • Added module docstring: "Ramsey experiment utilities for qubit characterization."
calibration_utils/ramsey/analysis.py
  • Added module docstring: "Analysis utilities for Ramsey experiment: fitting frequency offset and T2* decay."
  • Added function docstring for process_raw_dataset (line 48): "Convert IQ data to voltage if state discrimination is not used."
  • Updated class docstring for FitParameters (line 14): Changed from "qubit spectroscopy" to "Ramsey experiment" for accuracy
calibration_utils/ramsey/parameters.py
  • Added module docstring: "Parameter definitions for Ramsey experiment."
  • Added class docstring for NodeSpecificParameters (line 8): "Ramsey-specific parameters for frequency detuning and averaging."
  • Added class docstring for Parameters (line 21): "Combined parameters for Ramsey calibration node."
calibration_utils/ramsey/plotting.py
  • Added module docstring: "Plotting utilities for Ramsey experiment visualizations."
  • Replaced dict() call with dict literal {} (line 138)
    • Changed bbox=dict(facecolor="white", alpha=0.5) to bbox={"facecolor": "white", "alpha": 0.5}
  • Updated function docstring for plot_raw_data_with_fit (line 16): Changed from "resonator spectroscopy" to "Ramsey oscillations" for accuracy
  • Updated plot title (line 41): Changed from "Qubit spectroscopy" to "Ramsey oscillations" for accuracy
calibrations/1Q_calibrations/06a_ramsey.py
  • Added module docstring: "Ramsey calibration for qubit frequency and T2* measurement." (line 1)
  • Fixed import order (lines 1-7):
    • Moved from dataclasses import asdict to standard library import section (before third-party imports)
  • Fixed long docstrings by splitting lines (lines 170, 208):
    • execute_qua_program: Split into two lines
    • analyse_data: Split into two lines
  • Added function docstring for custom_param (line 56)
  • Added function docstring for save_results (line 249): "Save all node results and state updates."

@Kyung-hoon-Jung0 Kyung-hoon-Jung0 changed the title chore: add ramsey (from rebase) chore: add ramsey with precommit compliant Jan 12, 2026
Copy link

@sebastianorbell-qm sebastianorbell-qm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

@Kyung-hoon-Jung0 Kyung-hoon-Jung0 merged commit 770a2c3 into KAVR_12182025 Jan 13, 2026
3 checks passed
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.

3 participants