qibocal.cli package#

CLI entry point.

Submodules#

qibocal.cli.builders module#

class qibocal.cli.builders.ActionBuilder(runcard, folder, force, update)[source]#

Bases: object

Class for parsing and executing runcards. :param runcard: path containing the runcard. :type runcard: path :param folder: path for the output folder. :type folder: path :param force: option to overwrite the output folder if it exists already. :type force: bool :param update: option to update platform after each routine. :type update: bool

property platform#: Qibolab’s platform object.

property backend#: “Qibo’s backend object.

property qubits#: Qubits dictionary.

run()[source]#: Execute protocols in runcard.

dump_report()[source]#: Generate report as html.

dump_platform_runcard()[source]#: Dump platform runcard.

class qibocal.cli.builders.ReportBuilder(path: Path, history: History)[source]#

Bases: object

routine_name(routine, iteration)[source]#: Prettify routine’s name for report headers.

routine_qubits(task_id: tuple[qibocal.auto.runcard.Id, int])[source]#: Get local qubits parameter from Task if available otherwise use global one.

single_qubit_plot(task_id: tuple[qibocal.auto.runcard.Id, int], qubit: Union[str, int])[source]#: Generate single qubit plot.

plot(task_id: tuple[qibocal.auto.runcard.Id, int])[source]#: “Generate plot when only acquisition data are provided.

qibocal.cli.utils module#

Helper functions for the cli module

qibocal.cli.utils.generate_output_folder(folder, force)[source]#

Generation of qq output folder

Parameters

folder (path) – path for the output folder. If None it will be created a folder automatically
force (bool) – option to overwrite the output folder if it exists already.

Returns

Output path.