Merge pull request #854 from qiboteam/doc_generation

Fix protocols documentation generation

src/qibocal/auto/task.py

@@ -10,7 +10,7 @@
 from qibolab.serialize import dump_platform
 
 from ..config import log
-from ..protocols.characterization import Operation
+from ..protocols import Operation
 from .mode import ExecutionMode
 from .operation import Data, DummyPars, Results, Routine, dummy_operation
 from .runcard import Action, Id, Targets

src/qibocal/fitting/classifier/qubit_fit.py

@@ -5,10 +5,7 @@
 import numpy as np
 import numpy.typing as npt
 
-from qibocal.protocols.characterization.utils import (
-    cumulative,
-    effective_qubit_temperature,
-)
+from qibocal.protocols.utils import cumulative, effective_qubit_temperature
 
 
 def constructor(_hyperparams):

src/qibocal/protocols/characterization/classification.py → src/qibocal/protocols/classification.py

@@ -17,7 +17,7 @@
 from qibocal.auto.operation import RESULTSFILE, Data, Parameters, Results, Routine
 from qibocal.auto.serialize import serialize
 from qibocal.fitting.classifier import run
-from qibocal.protocols.characterization.utils import (
+from qibocal.protocols.utils import (
     LEGEND_FONT_SIZE,
     MESH_SIZE,
     TITLE_SIZE,

src/qibocal/protocols/characterization/dispersive_shift.py → src/qibocal/protocols/dispersive_shift.py

@@ -12,7 +12,7 @@
 
 from qibocal import update
 from qibocal.auto.operation import Data, Parameters, Results, Routine
-from qibocal.protocols.characterization.utils import (
+from qibocal.protocols.utils import (
     HZ_TO_GHZ,
     lorentzian,
     lorentzian_fit,

src/qibocal/protocols/characterization/dispersive_shift_qutrit.py → src/qibocal/protocols/dispersive_shift_qutrit.py

@@ -11,7 +11,7 @@
 from qibolab.sweeper import Parameter, Sweeper, SweeperType
 
 from qibocal.auto.operation import Results, Routine
-from qibocal.protocols.characterization.utils import (
+from qibocal.protocols.utils import (
     GHZ_TO_HZ,
     HZ_TO_GHZ,
     lorentzian,

src/qibocal/protocols/characterization/fast_reset/fast_reset.py → src/qibocal/protocols/fast_reset/fast_reset.py

@@ -10,7 +10,7 @@
 from qibolab.qubits import QubitId
 
 from qibocal.auto.operation import Data, Parameters, Results, Routine
-from qibocal.protocols.characterization.utils import table_dict, table_html
+from qibocal.protocols.utils import table_dict, table_html
 
 # TODO: IBM Fast Reset until saturation loop
 # https://quantum-computing.ibm.com/lab/docs/iql/manage/systems/reset/backend_reset

src/qibocal/protocols/characterization/flipping.py → src/qibocal/protocols/flipping.py

@@ -13,7 +13,7 @@
 
 from qibocal.auto.operation import Routine
 from qibocal.config import log
-from qibocal.protocols.characterization.utils import table_dict, table_html
+from qibocal.protocols.utils import table_dict, table_html
 
 from .flipping_signal import (
     FlippingSignalData,

src/qibocal/protocols/characterization/flipping_signal.py → src/qibocal/protocols/flipping_signal.py

@@ -14,7 +14,7 @@
 from qibocal import update
 from qibocal.auto.operation import Data, Parameters, Results, Routine
 from qibocal.config import log
-from qibocal.protocols.characterization.utils import table_dict, table_html
+from qibocal.protocols.utils import table_dict, table_html
 
 
 @dataclass

src/qibocal/protocols/characterization/flux_dependence/avoided_crossing.py → src/qibocal/protocols/flux_dependence/avoided_crossing.py

@@ -11,8 +11,8 @@
 from qibolab.qubits import QubitId, QubitPairId
 
 from qibocal.auto.operation import Data, Results, Routine
-from qibocal.protocols.characterization.two_qubit_interaction.utils import order_pair
-from qibocal.protocols.characterization.utils import HZ_TO_GHZ, table_dict, table_html
+from qibocal.protocols.two_qubit_interaction.utils import order_pair
+from qibocal.protocols.utils import HZ_TO_GHZ, table_dict, table_html
 
 from .qubit_flux_dependence import QubitFluxParameters, QubitFluxType
 from .qubit_flux_dependence import _acquisition as flux_acquisition

src/qibocal/protocols/characterization/flux_dependence/qubit_flux_dependence.py → src/qibocal/protocols/flux_dependence/qubit_flux_dependence.py

@@ -13,9 +13,7 @@
 from qibocal import update
 from qibocal.auto.operation import Data, Results, Routine
 from qibocal.config import log
-from qibocal.protocols.characterization.qubit_spectroscopy_ef import (
-    DEFAULT_ANHARMONICITY,
-)
+from qibocal.protocols.qubit_spectroscopy_ef import DEFAULT_ANHARMONICITY
 
 from ..utils import GHZ_TO_HZ, HZ_TO_GHZ, extract_feature, table_dict, table_html
 from . import resonator_flux_dependence, utils

src/qibocal/protocols/characterization/qutrit_classification.py → src/qibocal/protocols/qutrit_classification.py

@@ -9,17 +9,13 @@
 
 from qibocal.auto.operation import Routine
 from qibocal.fitting.classifier import run
-from qibocal.protocols.characterization.classification import (
+from qibocal.protocols.classification import (
     ClassificationType,
     SingleShotClassificationData,
     SingleShotClassificationParameters,
     SingleShotClassificationResults,
 )
-from qibocal.protocols.characterization.utils import (
-    MESH_SIZE,
-    evaluate_grid,
-    plot_results,
-)
+from qibocal.protocols.utils import MESH_SIZE, evaluate_grid, plot_results
 
 COLUMNWIDTH = 600
 LEGEND_FONT_SIZE = 20

src/qibocal/protocols/characterization/rabi/length.py → src/qibocal/protocols/rabi/length.py

@@ -14,7 +14,7 @@
 from qibocal import update
 from qibocal.auto.operation import Parameters, Routine
 from qibocal.config import log
-from qibocal.protocols.characterization.rabi.length_signal import (
+from qibocal.protocols.rabi.length_signal import (
     RabiLengthVoltData,
     RabiLengthVoltResults,
 )

src/qibocal/protocols/characterization/randomized_benchmarking/filtered_rb.py → src/qibocal/protocols/randomized_benchmarking/filtered_rb.py

@@ -6,10 +6,8 @@
 from qibolab.qubits import QubitId
 
 from qibocal.auto.operation import Results, Routine
-from qibocal.protocols.characterization.randomized_benchmarking.utils import (
-    rb_acquisition,
-)
-from qibocal.protocols.characterization.utils import table_dict, table_html
+from qibocal.protocols.randomized_benchmarking.utils import rb_acquisition
+from qibocal.protocols.utils import table_dict, table_html
 
 from .standard_rb import RBData, StandardRBParameters
 

src/qibocal/protocols/characterization/randomized_benchmarking/standard_rb.py → src/qibocal/protocols/randomized_benchmarking/standard_rb.py

@@ -42,7 +42,7 @@ class StandardRBParameters(Parameters):
     Defaults is ``None``."""
     noise_model: Optional[str] = None
     """For simulation purposes, string has to match what is in
-    :mod:`qibocal.protocols.characterization.randomized_benchmarking.noisemodels`"""
+    :mod:`qibocal.protocols.randomized_benchmarking.noisemodels`"""
     noise_params: Optional[list] = field(default_factory=list)
     """With this the noise model will be initialized, if not given random values will be used."""
     nshots: int = 10

src/qibocal/protocols/characterization/randomized_benchmarking/utils.py → src/qibocal/protocols/randomized_benchmarking/utils.py

@@ -16,8 +16,8 @@
     execute_transpiled_circuits,
 )
 from qibocal.config import raise_error
-from qibocal.protocols.characterization.randomized_benchmarking import noisemodels
-from qibocal.protocols.characterization.utils import significant_digit
+from qibocal.protocols.randomized_benchmarking import noisemodels
+from qibocal.protocols.utils import significant_digit
 
 from .circuit_tools import add_inverse_layer, add_measurement_layer, layer_circuit
 

src/qibocal/protocols/characterization/readout_characterization.py → src/qibocal/protocols/readout_characterization.py

@@ -11,7 +11,7 @@
 
 from qibocal import update
 from qibocal.auto.operation import Data, Parameters, Results, Routine
-from qibocal.protocols.characterization.utils import (
+from qibocal.protocols.utils import (
     effective_qubit_temperature,
     format_error_single_cell,
     round_report,

src/qibocal/protocols/characterization/readout_optimization/resonator_amplitude.py → src/qibocal/protocols/readout_optimization/resonator_amplitude.py

@@ -13,7 +13,7 @@
 from qibocal import update
 from qibocal.auto.operation import Data, Parameters, Results, Routine
 from qibocal.fitting.classifier.qubit_fit import QubitFit
-from qibocal.protocols.characterization.utils import table_dict, table_html
+from qibocal.protocols.utils import table_dict, table_html
 
 
 @dataclass

src/qibocal/protocols/characterization/readout_optimization/resonator_frequency.py → src/qibocal/protocols/readout_optimization/resonator_frequency.py

@@ -13,7 +13,7 @@
 from qibocal import update
 from qibocal.auto.operation import Data, Parameters, Results, Routine
 from qibocal.fitting.classifier.qubit_fit import QubitFit
-from qibocal.protocols.characterization.utils import HZ_TO_GHZ, table_dict, table_html
+from qibocal.protocols.utils import HZ_TO_GHZ, table_dict, table_html
 
 
 @dataclass

src/qibocal/protocols/characterization/readout_optimization/twpa_calibration/frequency.py → src/qibocal/protocols/readout_optimization/twpa_calibration/frequency.py

@@ -8,11 +8,11 @@
 
 from qibocal import update
 from qibocal.auto.operation import Data, Parameters, Results, Routine
-from qibocal.protocols.characterization import classification
-from qibocal.protocols.characterization.readout_optimization.resonator_frequency import (
+from qibocal.protocols import classification
+from qibocal.protocols.readout_optimization.resonator_frequency import (
     ResonatorFrequencyType,
 )
-from qibocal.protocols.characterization.utils import HZ_TO_GHZ, table_dict, table_html
+from qibocal.protocols.utils import HZ_TO_GHZ, table_dict, table_html
 
 
 @dataclass

src/qibocal/protocols/characterization/readout_optimization/twpa_calibration/frequency_SNR.py → src/qibocal/protocols/readout_optimization/twpa_calibration/frequency_SNR.py

@@ -9,15 +9,8 @@
 from qibolab.qubits import QubitId
 
 from qibocal.auto.operation import Data, Parameters, Results, Routine
-from qibocal.protocols.characterization.resonator_spectroscopy import (
-    resonator_spectroscopy,
-)
-from qibocal.protocols.characterization.utils import (
-    HZ_TO_GHZ,
-    PowerLevel,
-    table_dict,
-    table_html,
-)
+from qibocal.protocols.resonator_spectroscopy import resonator_spectroscopy
+from qibocal.protocols.utils import HZ_TO_GHZ, PowerLevel, table_dict, table_html
 
 
 @dataclass

src/qibocal/protocols/characterization/readout_optimization/twpa_calibration/frequency_power.py → src/qibocal/protocols/readout_optimization/twpa_calibration/frequency_power.py

@@ -8,8 +8,8 @@
 
 from qibocal import update
 from qibocal.auto.operation import Data, Parameters, Results, Routine
-from qibocal.protocols.characterization import classification
-from qibocal.protocols.characterization.utils import HZ_TO_GHZ, table_dict, table_html
+from qibocal.protocols import classification
+from qibocal.protocols.utils import HZ_TO_GHZ, table_dict, table_html
 
 
 @dataclass

src/qibocal/protocols/characterization/readout_optimization/twpa_calibration/power.py → src/qibocal/protocols/readout_optimization/twpa_calibration/power.py

@@ -7,8 +7,8 @@
 
 from qibocal import update
 from qibocal.auto.operation import Parameters, Results, Routine
-from qibocal.protocols.characterization import classification
-from qibocal.protocols.characterization.utils import table_dict, table_html
+from qibocal.protocols import classification
+from qibocal.protocols.utils import table_dict, table_html
 
 from . import frequency
 

src/qibocal/protocols/characterization/readout_optimization/twpa_calibration/power_SNR.py → src/qibocal/protocols/readout_optimization/twpa_calibration/power_SNR.py

@@ -9,15 +9,8 @@
 from qibolab.qubits import QubitId
 
 from qibocal.auto.operation import Data, Parameters, Results, Routine
-from qibocal.protocols.characterization.resonator_spectroscopy import (
-    resonator_spectroscopy,
-)
-from qibocal.protocols.characterization.utils import (
-    HZ_TO_GHZ,
-    PowerLevel,
-    table_dict,
-    table_html,
-)
+from qibocal.protocols.resonator_spectroscopy import resonator_spectroscopy
+from qibocal.protocols.utils import HZ_TO_GHZ, PowerLevel, table_dict, table_html
 
 
 @dataclass

src/qibocal/protocols/characterization/signal_experiments/time_of_flight_readout.py → src/qibocal/protocols/signal_experiments/time_of_flight_readout.py

@@ -10,7 +10,7 @@
 from qibolab.qubits import QubitId
 
 from qibocal.auto.operation import Data, Parameters, Results, Routine
-from qibocal.protocols.characterization.utils import S_TO_NS, table_dict, table_html
+from qibocal.protocols.utils import S_TO_NS, table_dict, table_html
 
 
 @dataclass

src/qibocal/protocols/characterization/two_qubit_interaction/chevron/chevron.py → src/qibocal/protocols/two_qubit_interaction/chevron/chevron.py

@@ -16,7 +16,7 @@
 from qibocal import update
 from qibocal.auto.operation import Data, Parameters, Results, Routine
 from qibocal.config import log
-from qibocal.protocols.characterization.utils import table_dict, table_html
+from qibocal.protocols.utils import table_dict, table_html
 
 from ..utils import fit_flux_amplitude, order_pair
 from .utils import COLORAXIS, chevron_fit, chevron_sequence

src/qibocal/protocols/characterization/two_qubit_interaction/cz_virtualz.py → src/qibocal/protocols/two_qubit_interaction/cz_virtualz.py

@@ -17,7 +17,7 @@
 from qibocal import update
 from qibocal.auto.operation import Data, Parameters, Results, Routine
 from qibocal.config import log
-from qibocal.protocols.characterization.utils import table_dict, table_html
+from qibocal.protocols.utils import table_dict, table_html
 
 from .utils import order_pair
 

tests/test_protocols.py

@@ -10,13 +10,13 @@
 from qibocal.auto.task import PLATFORM_DIR
 from qibocal.cli import utils
 from qibocal.cli._base import command
-from qibocal.protocols.characterization.flux_dependence.resonator_flux_dependence import (
+from qibocal.protocols.flux_dependence.resonator_flux_dependence import (
     ResonatorFluxParameters,
 )
-from qibocal.protocols.characterization.rabi.amplitude import RabiAmplitudeData
-from qibocal.protocols.characterization.rabi.ef import RabiAmplitudeEFData
-from qibocal.protocols.characterization.rabi.length import RabiLengthData
-from qibocal.protocols.characterization.rabi.utils import (
+from qibocal.protocols.rabi.amplitude import RabiAmplitudeData
+from qibocal.protocols.rabi.ef import RabiAmplitudeEFData
+from qibocal.protocols.rabi.length import RabiLengthData
+from qibocal.protocols.rabi.utils import (
     extract_rabi,
     rabi_amplitude_function,
     rabi_length_function,

tests/test_randomized_benchmarking.py

@@ -4,11 +4,8 @@
 import pytest
 import qibo
 
-from qibocal.protocols.characterization.randomized_benchmarking import (
-    fitting,
-    noisemodels,
-)
-from qibocal.protocols.characterization.randomized_benchmarking.utils import (
+from qibocal.protocols.randomized_benchmarking import fitting, noisemodels
+from qibocal.protocols.randomized_benchmarking.utils import (
     RB_Generator,
     number_to_str,
     random_clifford,

tests/test_task_options.py

@@ -10,10 +10,8 @@
 from qibocal.auto.runcard import Runcard
 from qibocal.auto.task import Task
 from qibocal.cli.report import ExecutionMode
-from qibocal.protocols.characterization.classification import (
-    SingleShotClassificationParameters,
-)
-from qibocal.protocols.characterization.readout_mitigation_matrix import (
+from qibocal.protocols.classification import SingleShotClassificationParameters
+from qibocal.protocols.readout_mitigation_matrix import (
     ReadoutMitigationMatrixParameters,
 )
 

tests/test_update.py

@@ -10,7 +10,7 @@
 from qibolab.pulses import Drag
 
 from qibocal import update
-from qibocal.protocols.characterization.signal_experiments.calibrate_state_discrimination import (
+from qibocal.protocols.signal_experiments.calibrate_state_discrimination import (
     CalibrateStateDiscriminationResults,
 )
 

tests/test_utils.py

@@ -1,6 +1,6 @@
 import numpy as np
 
-from qibocal.protocols.characterization.utils import cumulative, eval_magnitude
+from qibocal.protocols.utils import cumulative, eval_magnitude
 
 
 def test_cumulative():