How to use Qibocal as a library#

Qibocal also allows executing protocols without the standard interface.

In the following tutorial we show how to run a single protocol using Qibocal as a library. For this particular example we will focus on the single shot classification protocol.

from qibocal.protocols.characterization import Operation
from qibolab import create_platform

# allocate platform
platform = create_platform("....")
# get qubits from platform
qubits = platform.qubits

# we select the protocol
protocol = Operation.single_shot_classification.value

protocol is a Routine object which contains all the necessary methods to execute the experiment.

In order to run a protocol the user needs to specify the parameters. The user can check which parameters need to be provided either by checking the documentation of the specific protocol or by simply inspecting protocol.parameters_type. For single_shot_classification we can pass just the number of shots in the following way:

parameters = experiment.parameters_type.load(dict(nshots=1024))

After defining the parameters, the user can perform the acquisition using experiment.acquisition which accepts the following parameters:

and returns the following:

data, acquisition_time = experiment.acquisition(params=parameters,

The user can now use the raw data acquired by the quantum processor to perform an arbitrary post-processing analysis. This is one of the main advantages of this API compared to the cli execution.

The fitting corresponding to the experiment ( can be launched in the following way:

fit, fit_time =

To be more specific the user should pass as input data which is of type experiment.data_type and the outputs are the following:

It is also possible to access the plots and the tables generated in the report using which accepts the following parameters:

# Plot for qubit 0
qubit = 0
figs, html_content =, qubit=0, fit=fit) returns the following:

  • figs: list of plotly figures

  • html_content: raw html with additional information usually in the form of a table

In our case we get the following figure for qubit 0:


and we can render the html content in the following way:

import IPython