API reference

In this section we present the main qibocal components and primitives included in the public API.

• qibocal package
  • Executor
    • Executor.create()
    • Executor._init()
    • Executor.close()
    • Executor.open()
    • Executor._dump_task()
    • Executor._context()
    • Executor.acquire()
    • Executor._completed_context()
    • Executor.fit()
    • Executor.report()
    • Executor.update()
  • create_calibration_platform()
  • BoundProtocol
    • BoundProtocol._is_protocol
    • BoundProtocol.protocol
    • BoundProtocol.parameters
    • BoundProtocol.fitpars
    • BoundProtocol.reportpars
  • Protocol
    • Protocol.acquisition
    • Protocol.fit
    • Protocol.report
    • Protocol.update
    • Protocol.two_qubit_gates
    • Protocol.parameters_type
    • Protocol.data_type
    • Protocol.results_type
    • Protocol._is_protocol
  • Completed
    • Completed.task
    • Completed.path
    • Completed._data
    • Completed._results
    • Completed.data_time
    • Completed.results_time
    • Completed.bound
    • Completed.reports
    • Completed.protocol_id
    • Completed.error
    • Completed.success
    • Completed._targets
    • Completed.notes
    • Completed.targets
    • Completed.data
    • Completed.results
    • Completed.dump_parameters()
    • Completed.dump_notes()
    • Completed.dump_data()
    • Completed.dump_results()
    • Completed.should_update()
    • Completed.update_platform()
  • Note
    • Note.model_config
    • Note.content
    • Note.timestamp
    • Note.author
    • Note.normalize_timestamp()
    • Note._abc_impl
    • Note._calculate_keys()
    • Note._copy_and_set_values()
    • Note._get_value()
    • Note._iter()
    • Note._setattr_handler()
    • Note.construct()
    • Note.copy()
    • Note.dict()
    • Note.from_orm()
    • Note.json()
    • Note.model_computed_fields
    • Note.model_construct()
    • Note.model_copy()
    • Note.model_dump()
    • Note.model_dump_json()
    • Note.model_extra
    • Note.model_fields
    • Note.model_fields_set
    • Note.model_json_schema()
    • Note.model_parametrized_name()
    • Note.model_post_init()
    • Note.model_rebuild()
    • Note.model_validate()
    • Note.model_validate_json()
    • Note.model_validate_strings()
    • Note.parse_file()
    • Note.parse_obj()
    • Note.parse_raw()
    • Note.schema()
    • Note.schema_json()
    • Note.update_forward_refs()
    • Note.validate()
  • Subpackages
    • qibocal.auto package
    • qibocal.calibration package
    • qibocal.cli package
    • qibocal.protocols package
    • qibocal.web package
  • Submodules
  • qibocal.config module
    • raise_error()
    • CustomHandler
  • qibocal.result module
    • IQ
    • _lift()
    • _sink()
    • collect()
    • unpack()
    • magnitude()
    • average()
    • average_iq()
    • phase()
    • probability()
  • qibocal.update module
    • _dump_pair()
    • replace()
    • readout_frequency()
    • bare_resonator_frequency()
    • dressed_resonator_frequency()
    • readout_amplitude()
    • drive_frequency()
    • drive_amplitude()
    • drive_duration()
    • lo_frequency()
    • lo_attenuation()
    • crosstalk_matrix()
    • iq_angle()
    • threshold()
    • mean_gnd_states()
    • mean_exc_states()
    • readout_fidelity()
    • virtual_phases()
    • cz_flux_path()
    • CZ_duration()
    • CZ_amplitude()
    • iSWAP_duration()
    • iSWAP_amplitude()
    • cnot_sequence()
    • t1()
    • t2()
    • t2_spin_echo()
    • drag_pulse_beta()
    • sweetspot()
    • flux_offset()
    • frequency_12_transition()
    • readout_coupling()
    • pair_coupling()
    • kernel()
  • qibocal.version module