Skip to content

Conversation

@Kyung-hoon-Jung0
Copy link
Collaborator

Summary

Pre-commit Compliance: T1 Relaxation Time Measurement).
This PR focuses solely on pre-commit (pylint/black) compliance for the resonator spectroscopy versus power calibration files.

  • No functional or behavioral changes
  • Module/function/class docstrings, line length fixes, and import ordering
  • Goal: ensure clean pre-commit passes

Files Modified

1. calibrations/1Q_calibrations/05_T1.py

Changes:

  • Added module docstring: """T1 relaxation time measurement calibration.""" (line 1)
  • Fixed import order: Moved from dataclasses import asdict from line 4 to line 3, placing it in the standard library import section before third-party imports
  • Fixed line 189: Split long docstring (132 characters) for analyse_data function into two lines to comply with 120-character limit
  • Added function docstring: Added docstring """Allow the user to locally set the node parameters for debugging purposes.""" to custom_param function (line 57)
  • Added function docstring: Added docstring """Save the node results and state.""" to save_results function (line 235)

Pylint violations fixed:

  • C0114: missing-module-docstring
  • C0411: wrong-import-order
  • C0301: line-too-long (line 189)
  • C0116: missing-function-docstring (custom_param, save_results)

2. calibration_utils/T1/__init__.py

Changes:

  • Added module docstring: """T1 relaxation time measurement calibration utilities.""" (line 1)

Pylint violations fixed:

  • C0114: missing-module-docstring

3. calibration_utils/T1/analysis.py

Changes:

  • Added module docstring: """T1 relaxation time analysis functions.""" (line 1)
  • Fixed import order:
    • Moved from dataclasses import dataclass to line 4 (standard library section)
    • Moved from typing import Tuple to line 5 (standard library section)
    • Added blank line after standard library imports before third-party imports
    • Grouped all from qualibrate and from qualibration_libs imports together
  • Fixed line 46: Split long f-string into two lines for SUCCESS message
  • Fixed line 50: Split long f-string into two lines for FAIL message
  • Added function docstring: Added docstring """Process the raw dataset by converting IQ data to voltage if state discrimination is not used.""" to process_raw_dataset function (line 61)
  • Fixed dunder method calls (lines 117-119):
    • Changed .__float__() to float() for t1 and t1_error values
    • Changed .__bool__() to bool() for success value

Pylint violations fixed:

  • C0114: missing-module-docstring
  • C0411: wrong-import-order
  • C0301: line-too-long (lines 46, 50)
  • C0116: missing-function-docstring (process_raw_dataset)
  • C2801: unnecessary-dunder-call

4. calibration_utils/T1/parameters.py

Changes:

  • Added module docstring: """Parameters for T1 relaxation time measurement calibration.""" (line 1)
  • Added class docstring: """Node-specific parameters for T1 measurement.""" to NodeSpecificParameters class (line 9)
  • Added class docstring: """Combined parameters for T1 relaxation time measurement calibration.""" to Parameters class (line 22)

Pylint violations fixed:

  • C0114: missing-module-docstring
  • C0115: missing-class-docstring (NodeSpecificParameters, Parameters)

5. calibration_utils/T1/plotting.py

Changes:

  • Added module docstring: """Plotting functions for T1 relaxation time measurement.""" (line 1)
  • Fixed import grouping:
    • Separated from typing import List into its own standard library section
    • Added blank line after standard library imports
    • Grouped third-party imports (xarray, matplotlib)
    • Added blank line before local imports
  • Fixed dict literal (line 84): Changed dict(facecolor="white", alpha=0.5) to {"facecolor": "white", "alpha": 0.5}

Pylint violations fixed:

  • C0114: missing-module-docstring
  • C0411: wrong-import-order
  • R1735: use-dict-literal

@Kyung-hoon-Jung0 Kyung-hoon-Jung0 merged commit 506e964 into KAVR_12182025 Jan 12, 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.

2 participants