![\"image0\"](\"figures/Banner.jpeg\")
\n",
"\n",
""
]
},
{
"cell_type": "code",
"execution_count": 1,
"id": "20034433",
"metadata": {
"execution": {
"iopub.execute_input": "2025-03-12T18:07:47.811447Z",
"iopub.status.busy": "2025-03-12T18:07:47.811057Z",
"iopub.status.idle": "2025-03-12T18:07:49.714950Z",
"shell.execute_reply": "2025-03-12T18:07:49.713846Z"
},
"tags": [
"imports",
"header_0"
]
},
"outputs": [],
"source": [
"from functools import partial\n",
"from typing import Literal\n",
"\n",
"import matplotlib.pyplot as plt\n",
"import numpy as np\n",
"import rich # noqa:F401\n",
"from qcodes.parameters import ManualParameter\n",
"from sklearn.metrics import ConfusionMatrixDisplay\n",
"\n",
"import quantify_core.data.handling as dh\n",
"from quantify_core.analysis.readout_calibration_analysis import ReadoutCalibrationAnalysis\n",
"from quantify_scheduler import QuantumDevice, Schedule, ScheduleGettable\n",
"from quantify_scheduler.enums import BinMode\n",
"from quantify_scheduler.operations import Measure, Reset, Rxy\n",
"\n",
"from utils import display_dict, initialize_hardware, run_schedule, show_connectivity # noqa:F401"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "1305e69a",
"metadata": {
"execution": {
"iopub.execute_input": "2025-03-12T18:07:49.718310Z",
"iopub.status.busy": "2025-03-12T18:07:49.717775Z",
"iopub.status.idle": "2025-03-12T18:07:49.721583Z",
"shell.execute_reply": "2025-03-12T18:07:49.720849Z"
},
"tags": [
"config",
"header_1"
]
},
"outputs": [],
"source": [
"hw_config_path = \"configs/tuning_spin_coupled_pair_hardware_config.json\"\n",
"device_path = \"devices/spin_device_2q.json\""
]
},
{
"cell_type": "code",
"execution_count": 3,
"id": "6b6d365b",
"metadata": {
"execution": {
"iopub.execute_input": "2025-03-12T18:07:49.723526Z",
"iopub.status.busy": "2025-03-12T18:07:49.723258Z",
"iopub.status.idle": "2025-03-12T18:07:49.727634Z",
"shell.execute_reply": "2025-03-12T18:07:49.726871Z"
},
"tags": [
"header_2"
]
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Data will be saved in:\n",
"/root/quantify-data\n"
]
}
],
"source": [
"# Enter your own dataset directory here!\n",
"dh.set_datadir(dh.default_datadir())"
]
},
{
"cell_type": "code",
"execution_count": 4,
"id": "51780b5e",
"metadata": {
"execution": {
"iopub.execute_input": "2025-03-12T18:07:49.729716Z",
"iopub.status.busy": "2025-03-12T18:07:49.729243Z",
"iopub.status.idle": "2025-03-12T18:07:50.152619Z",
"shell.execute_reply": "2025-03-12T18:07:50.151283Z"
},
"tags": [
"header_3"
]
},
"outputs": [],
"source": [
"quantum_device = QuantumDevice.from_json_file(device_path)\n",
"qubit = quantum_device.get_element(\"q0\")\n",
"quantum_device.hardware_config.load_from_json_file(hw_config_path)\n",
"cluster_ip = None\n",
"meas_ctrl, inst_coord, cluster = initialize_hardware(quantum_device, ip=cluster_ip)"
]
},
{
"cell_type": "markdown",
"id": "dc86f884",
"metadata": {},
"source": [
"# Discriminated Single Shot Readout\n",
"Here we show how to run a readout calibration experiment and fit a discriminator with a linear discriminant analysis.\n",
"This experiment is sometimes called multi-state discrimination."
]
},
{
"cell_type": "markdown",
"id": "27d5b220",
"metadata": {
"tags": [
"no_demo"
]
},
"source": [
"## Setup\n",
"In this section we configure the hardware configuration which specifies the connectivity of our system.\n",
"\n",
"The experiments of this tutorial are meant to be executed with a Qblox Cluster controlling a transmon system.\n",
"The experiments can also be executed using a dummy Qblox device that is created via an instance of the `Cluster` class, and is initialized with a dummy configuration.\n",
"When using a dummy device, the analysis will not work because the experiments will return `np.nan` values.\n",
"\n",
"### Configuration file\n",
"\n",
"This is a template hardware configuration file for a 2-qubit system with a flux-control line which can be used to tune the qubit frequency. We will only work with qubit 0.\n",
"\n",
"The hardware connectivity is as follows, by cluster slot:\n",
"\n",
"- **QCM** (Slot 2)\n",
" - $\\text{O}^{1}$: Flux line for `q0`.\n",
" - $\\text{O}^{2}$: Flux line for `q1`.\n",
"\n",
"- **QCM-RF** (Slot 6)\n",
" - $\\text{O}^{1}$: Drive line for `q0` using fixed 80 MHz IF.\n",
" - $\\text{O}^{2}$: Drive line for `q1` using fixed 80 MHz IF.\n",
"\n",
"- **QRM-RF** (Slot 8)\n",
" - $\\text{O}^{1}$ and $\\text{I}^{1}$: Shared readout line for `q0`/`q1` using a fixed LO set at 7.5 GHz.\n",
"\n",
"Note that in the hardware configuration below the mixers are uncorrected, but for high fidelity experiments this should also be done for all the modules."
]
},
{
"cell_type": "markdown",
"id": "8f87c8c3",
"metadata": {
"tags": [
"no_demo"
]
},
"source": [
"### Quantum device settings\n",
"Here we initialize our `QuantumDevice` and our qubit parameters, checkout this [tutorial](https://quantify-os.org/docs/quantify-scheduler/tutorials/Operations%20and%20Qubits.html) for further details.\n",
"\n",
"In short, a `QuantumDevice` contains device elements where we save our found parameters. Here we are loading a template for 2 qubits, but we will only use qubit 0."
]
},
{
"cell_type": "markdown",
"id": "71792a61",
"metadata": {
"lines_to_next_cell": 0
},
"source": [
"## Schedule definition"
]
},
{
"cell_type": "code",
"execution_count": 5,
"id": "45ba9317",
"metadata": {
"execution": {
"iopub.execute_input": "2025-03-12T18:07:50.156959Z",
"iopub.status.busy": "2025-03-12T18:07:50.156408Z",
"iopub.status.idle": "2025-03-12T18:07:50.163050Z",
"shell.execute_reply": "2025-03-12T18:07:50.162111Z"
}
},
"outputs": [],
"source": [
"def readout_calibration_sched(\n",
" qubit: str,\n",
" prepared_states: list[int],\n",
" repetitions: int = 1,\n",
" acq_protocol: Literal[\n",
" \"SSBIntegrationComplex\", \"ThresholdedAcquisition\"\n",
" ] = \"SSBIntegrationComplex\",\n",
") -> Schedule:\n",
" \"\"\"\n",
" Make a schedule for readout calibration.\n",
"\n",
" Parameters\n",
" ----------\n",
" qubit\n",
" The name of the qubit e.g., :code:`\"q0\"` to perform the experiment on.\n",
" prepared_states\n",
" A list of integers indicating which state to prepare the qubit in before measuring.\n",
" The ground state corresponds to 0 and the first-excited state to 1.\n",
" repetitions\n",
" The number of times the schedule will be repeated. Fixed to 1 for this schedule.\n",
" acq_protocol\n",
" The acquisition protocol used for the readout calibration. By default\n",
" \"SSBIntegrationComplex\", but \"ThresholdedAcquisition\" can be\n",
" used for verifying thresholded acquisition parameters.\n",
"\n",
" Returns\n",
" -------\n",
" :\n",
" An experiment schedule.\n",
"\n",
" Raises\n",
" ------\n",
" NotImplementedError\n",
" If the prepared state is > 1.\n",
"\n",
" \"\"\"\n",
" schedule = Schedule(f\"Readout calibration {qubit}\", repetitions=1)\n",
"\n",
" for i, prep_state in enumerate(prepared_states):\n",
" schedule.add(Reset(qubit), label=f\"Reset {i}\")\n",
" if prep_state == 0:\n",
" pass\n",
" elif prep_state == 1:\n",
" schedule.add(Rxy(qubit=qubit, theta=180, phi=0))\n",
" else:\n",
" raise NotImplementedError(\n",
" \"Preparing the qubit in the higher excited states is not supported yet.\"\n",
" )\n",
" schedule.add(\n",
" Measure(qubit, acq_index=i, bin_mode=BinMode.APPEND, acq_protocol=acq_protocol),\n",
" label=f\"Measurement {i}\",\n",
" )\n",
" return schedule"
]
},
{
"cell_type": "markdown",
"id": "a7244119",
"metadata": {
"lines_to_next_cell": 0
},
"source": [
"## SSRO with single side band (SSB) integration"
]
},
{
"cell_type": "code",
"execution_count": 6,
"id": "65c447fc",
"metadata": {
"execution": {
"iopub.execute_input": "2025-03-12T18:07:50.166925Z",
"iopub.status.busy": "2025-03-12T18:07:50.166110Z",
"iopub.status.idle": "2025-03-12T18:07:50.171387Z",
"shell.execute_reply": "2025-03-12T18:07:50.170448Z"
},
"lines_to_next_cell": 0
},
"outputs": [],
"source": [
"states = ManualParameter(name=\"states\", unit=\"\", label=\"Prepared state\")\n",
"states.batch_size = 400\n",
"states.batched = True\n",
"\n",
"readout_calibration_sched_kwargs = dict(\n",
" qubit=qubit.name, prepared_states=states, acq_protocol=\"SSBIntegrationComplex\"\n",
")\n",
"\n",
"# set gettable\n",
"ssro_gettable = ScheduleGettable(\n",
" quantum_device,\n",
" schedule_function=readout_calibration_sched,\n",
" schedule_kwargs=readout_calibration_sched_kwargs,\n",
" real_imag=True,\n",
" batched=True,\n",
")\n",
"\n",
"# set measurement control\n",
"meas_ctrl.gettables(ssro_gettable)"
]
},
{
"cell_type": "code",
"execution_count": 7,
"id": "6e792bf3",
"metadata": {
"execution": {
"iopub.execute_input": "2025-03-12T18:07:50.174416Z",
"iopub.status.busy": "2025-03-12T18:07:50.174253Z",
"iopub.status.idle": "2025-03-12T18:07:50.327286Z",
"shell.execute_reply": "2025-03-12T18:07:50.326154Z"
}
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Starting batched measurement...\n",
"Iterative settable(s) [outer loop(s)]:\n",
"\t --- (None) --- \n",
"Batched settable(s):\n",
"\t states \n",
"Batch size limit: 400\n",
"\n"
]
},
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "22e98d358ecf4b6ebac34ee07eebf098",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"Completed: 0%| [ elapsed time: 00:00 | time left: ? ] it"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"<xarray.Dataset> Size: 48kB\n",
"Dimensions: (x0: 2000)\n",
"Coordinates:\n",
" * x0 (x0) int64 16kB 0 1 0 1 0 1 0 1 0 1 0 1 ... 0 1 0 1 0 1 0 1 0 1 0 1\n",
"Data variables:\n",
" y0 (x0) float64 16kB 0.007992 0.0506 0.01592 ... 0.01893 0.03871\n",
" y1 (x0) float64 16kB 0.01807 0.03674 2.638e-05 ... 0.03133 0.03444\n",
"Attributes:\n",
" tuid: 20250312-180750-179-f3b51c\n",
" name: Single shot readout experiment\n",
" grid_2d: False\n",
" grid_2d_uniformly_spaced: False\n",
" 1d_2_settables_uniformly_spaced: False<xarray.Dataset> Size: 480kB\n",
"Dimensions: (x0: 20000)\n",
"Coordinates:\n",
" * x0 (x0) int64 160kB 0 1 0 1 0 1 0 1 0 1 0 1 ... 1 0 1 0 1 0 1 0 1 0 1\n",
"Data variables:\n",
" y0 (x0) float64 160kB 0.0 0.0 0.0 1.0 0.0 1.0 ... 1.0 0.0 1.0 0.0 1.0\n",
" y1 (x0) float64 160kB nan nan nan nan nan nan ... nan nan nan nan nan\n",
"Attributes:\n",
" tuid: 20250312-180751-628-2411cd\n",
" name: Discriminated single shot readout exper...\n",
" grid_2d: False\n",
" grid_2d_uniformly_spaced: False\n",
" 1d_2_settables_uniformly_spaced: False| setting | \nvalue | \n
|---|---|
| num_bins | \n400 | \n
| index | \n0 | \n
| setting | \nvalue | \n
|---|---|
| offset_ch0_path_I | \nNone | \n
| offset_ch0_path_Q | \nNone | \n
| offset_ch1_path_I | \nNone | \n
| offset_ch1_path_Q | \nNone | \n
| in0_gain | \nNone | \n
| in1_gain | \nNone | \n
| distortion_corrections | \n[{'bt': {'coeffs': None, 'config': 'QbloxFilte... | \n
| out0_lo_freq_cal_type_default | \nLoCalEnum.ON_LO_INTERM_FREQ_CHANGE | \n
| out1_lo_freq_cal_type_default | \nLoCalEnum.OFF | \n
| lo0_freq | \n5020000000.0 | \n
| lo1_freq | \nNone | \n
| out0_att | \n0 | \n
| out1_att | \nNone | \n
| in0_att | \nNone | \n
| setting | \nvalue | \n
|---|---|
| reference_source | \ninternal | \n
| sync_on_external_trigger | \nNone | \n
| setting | \nvalue | \n
|---|---|
| q0:mw-q0.f_larmor | \n0 | \n
| q1:mw-q1.f_larmor | \n0 | \n
| setting | \nvalue | \n
|---|---|
| graph | \n[[cluster0.module2.real_output_0, q0:gt], [clu... | \n
| setting | \nvalue | \n
|---|---|
| config_type | \nquantify_scheduler.backends.qblox_backend.Qblo... | \n
| setting | \nvalue | \n
|---|---|
| instrument_type | \nQRM | \n
| setting | \nvalue | \n
|---|---|
| interm_freq | \n80000000.0 | \n
| setting | \nvalue | \n
|---|---|
| offset_ch0_path_I | \nNone | \n
| offset_ch0_path_Q | \nNone | \n
| offset_ch1_path_I | \nNone | \n
| offset_ch1_path_Q | \nNone | \n
| in0_gain | \nNone | \n
| in1_gain | \nNone | \n
| distortion_corrections | \n[{'bt': {'coeffs': None, 'config': 'QbloxFilte... | \n
| out0_lo_freq_cal_type_default | \nLoCalEnum.OFF | \n
| out1_lo_freq_cal_type_default | \nLoCalEnum.OFF | \n
| setting | \nvalue | \n
|---|---|
| instrument_type | \nCluster | \n
| sequence_to_file | \nFalse | \n
| ref | \ninternal | \n
| setting | \nvalue | \n
|---|---|
| sync_en | \nTrue | \n
| channel_name | \nreal_output_0 | \n
| channel_name_measure | \n[real_input_0, real_input_1] | \n
| connected_output_indices | \n(0,) | \n
| connected_input_indices | \n(0, 1) | \n
| seq_fn | \nNone | \n
| thresholded_acq_trigger_write_en | \nFalse | \n
| thresholded_acq_trigger_write_address | \nNone | \n
| thresholded_acq_trigger_write_invert | \nFalse | \n
| nco_en | \nTrue | \n
| init_offset_awg_path_I | \n0.0 | \n
| init_offset_awg_path_Q | \n0.0 | \n
| init_gain_awg_path_I | \n1.0 | \n
| init_gain_awg_path_Q | \n1.0 | \n
| modulation_freq | \n120000000.0 | \n
| mixer_corr_phase_offset_degree | \nNone | \n
| mixer_corr_gain_ratio | \nNone | \n
| auto_sideband_cal | \nSidebandCalEnum.OFF | \n
| integration_length_acq | \n1900 | \n
| thresholded_acq_threshold | \n52.998119 | \n
| thresholded_acq_rotation | \n314.819709 | \n
| ttl_acq_input_select | \nNone | \n
| ttl_acq_threshold | \nNone | \n
| ttl_acq_auto_bin_incr_en | \nNone | \n
| setting | \nvalue | \n
|---|---|
| acq_protocol | \nThresholdedAcquisition | \n
| bin_mode | \nappend | \n
| acq_return_type | \n<class 'numpy.int32'> | \n
| repetitions | \n1 | \n
| setting | \nvalue | \n
|---|---|
| interm_freq | \n70000000.0 | \n
| setting | \nvalue | \n
|---|---|
| repetitions | \n1 | \n
| setting | \nvalue | \n
|---|---|
| repetitions | \n1 | \n
| setting | \nvalue | \n
|---|---|
| instrument_type | \nQCM | \n
| setting | \nvalue | \n
|---|---|
| sync_en | \nTrue | \n
| channel_name | \nreal_output_0 | \n
| channel_name_measure | \nNone | \n
| connected_output_indices | \n(0,) | \n
| connected_input_indices | \n() | \n
| seq_fn | \nNone | \n
| thresholded_acq_trigger_write_en | \nNone | \n
| thresholded_acq_trigger_write_address | \nNone | \n
| thresholded_acq_trigger_write_invert | \nFalse | \n
| nco_en | \nTrue | \n
| init_offset_awg_path_I | \n0.0 | \n
| init_offset_awg_path_Q | \n0.0 | \n
| init_gain_awg_path_I | \n1.0 | \n
| init_gain_awg_path_Q | \n1.0 | \n
| modulation_freq | \n0 | \n
| mixer_corr_phase_offset_degree | \nNone | \n
| mixer_corr_gain_ratio | \nNone | \n
| auto_sideband_cal | \nSidebandCalEnum.OFF | \n
| integration_length_acq | \nNone | \n
| thresholded_acq_threshold | \nNone | \n
| thresholded_acq_rotation | \nNone | \n
| ttl_acq_input_select | \nNone | \n
| ttl_acq_threshold | \nNone | \n
| ttl_acq_auto_bin_incr_en | \nNone | \n
| setting | \nvalue | \n
|---|---|
| auto_lo_cal | \non_lo_interm_freq_change | \n
| auto_sideband_cal | \non_interm_freq_change | \n
| setting | \nvalue | \n
|---|---|
| offset_ch0_path_I | \nNone | \n
| offset_ch0_path_Q | \nNone | \n
| offset_ch1_path_I | \nNone | \n
| offset_ch1_path_Q | \nNone | \n
| in0_gain | \nNone | \n
| in1_gain | \nNone | \n
| distortion_corrections | \n[{'bt': {'coeffs': None, 'config': 'QbloxFilte... | \n
| out0_lo_freq_cal_type_default | \nLoCalEnum.OFF | \n
| out1_lo_freq_cal_type_default | \nLoCalEnum.OFF | \n
| lo0_freq | \nNone | \n
| lo1_freq | \nNone | \n
| out0_att | \nNone | \n
| out1_att | \nNone | \n
| in0_att | \nNone | \n
| setting | \nvalue | \n
|---|---|
| instrument_type | \nQCM_RF | \n
| setting | \nvalue | \n
|---|---|
| auto_lo_cal | \non_lo_interm_freq_change | \n
| auto_sideband_cal | \non_interm_freq_change | \n
| setting | \nvalue | \n
|---|---|
| repetitions | \n1 | \n
| setting | \nvalue | \n
|---|---|
| acq_channel | \n0 | \n
| acq_indices | \n[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13,... | \n
| thresholded_trigger_count | \nNone | \n
| setting | \nvalue | \n
|---|---|
| sync_en | \nTrue | \n
| channel_name | \ncomplex_output_0 | \n
| channel_name_measure | \nNone | \n
| connected_output_indices | \n(0, 1) | \n
| connected_input_indices | \n() | \n
| seq_fn | \nNone | \n
| thresholded_acq_trigger_write_en | \nNone | \n
| thresholded_acq_trigger_write_address | \nNone | \n
| thresholded_acq_trigger_write_invert | \nFalse | \n
| nco_en | \nTrue | \n
| init_offset_awg_path_I | \n0.0 | \n
| init_offset_awg_path_Q | \n0.0 | \n
| init_gain_awg_path_I | \n1.0 | \n
| init_gain_awg_path_Q | \n1.0 | \n
| modulation_freq | \n80000000.0 | \n
| mixer_corr_phase_offset_degree | \n0.0 | \n
| mixer_corr_gain_ratio | \n1.0 | \n
| auto_sideband_cal | \nSidebandCalEnum.ON_INTERM_FREQ_CHANGE | \n
| integration_length_acq | \nNone | \n
| thresholded_acq_threshold | \nNone | \n
| thresholded_acq_rotation | \nNone | \n
| ttl_acq_input_select | \nNone | \n
| ttl_acq_threshold | \nNone | \n
| ttl_acq_auto_bin_incr_en | \nNone | \n