API reference

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

• qibolab package
  • MetaBackend
    • MetaBackend.load()
    • MetaBackend.list_available()
  • QibolabBackend
    • QibolabBackend.apply_gate()
    • QibolabBackend.apply_gate_density_matrix()
    • QibolabBackend.assign_measurements()
    • QibolabBackend.execute_circuit()
    • QibolabBackend.execute_circuits()
  • Channel
    • Channel.device
    • Channel.path
    • Channel.port
    • Channel.model_config
  • DcChannel
    • DcChannel.model_config
  • IqChannel
    • IqChannel.mixer
    • IqChannel.model_config
    • IqChannel.lo
  • AcquisitionChannel
    • AcquisitionChannel.model_config
    • AcquisitionChannel.twpa_pump
    • AcquisitionChannel.probe
  • create_dummy()
  • AcquisitionType
    • AcquisitionType.DISCRIMINATION
    • AcquisitionType.INTEGRATION
    • AcquisitionType.RAW
    • AcquisitionType.SPECTROSCOPY
  • AveragingMode
    • AveragingMode.CYCLIC
    • AveragingMode.SINGLESHOT
    • AveragingMode.SEQUENTIAL
    • AveragingMode.average
  • ConfigKinds
    • ConfigKinds.extend()
    • ConfigKinds.reset()
    • ConfigKinds.registered()
    • ConfigKinds.adapted()
  • create_platform()
  • locate_platform()
  • Platform
    • Platform.name
    • Platform.parameters
    • Platform.instruments
    • Platform.qubits
    • Platform.couplers
    • Platform.resonator_type
    • Platform.is_connected
    • Platform.nqubits
    • Platform.pairs
    • Platform.ordered_pairs
    • Platform.settings
    • Platform.natives
    • Platform.sampling_rate
    • Platform.components
    • Platform.channels
    • Platform.qubit_channels
    • Platform.coupler_channels
    • Platform.config()
    • Platform.update()
    • Platform.connect()
    • Platform.disconnect()
    • Platform.execute()
    • Platform.load()
    • Platform.dump()
    • Platform.qubit()
    • Platform.coupler()
  • Waveform
  • IqWaveform
  • BaseEnvelope
    • BaseEnvelope.i()
    • BaseEnvelope.q()
    • BaseEnvelope.envelopes()
    • BaseEnvelope.model_config
  • Rectangular
    • Rectangular.kind
    • Rectangular.i()
    • Rectangular.model_config
  • Exponential
    • Exponential.kind
    • Exponential.tau
    • Exponential.upsilon
    • Exponential.g
    • Exponential.i()
    • Exponential.model_config
  • Gaussian
    • Gaussian.kind
    • Gaussian.rel_sigma
    • Gaussian.i()
    • Gaussian.model_config
  • GaussianSquare
    • GaussianSquare.kind
    • GaussianSquare.rel_sigma
    • GaussianSquare.width
    • GaussianSquare.i()
    • GaussianSquare.model_config
  • Drag
    • Drag.kind
    • Drag.rel_sigma
    • Drag.beta
    • Drag.i()
    • Drag.q()
    • Drag.model_config
  • Iir
    • Iir.kind
    • Iir.a
    • Iir.b
    • Iir.target
    • Iir.i()
    • Iir.q()
    • Iir.model_config
  • Snz
    • Snz.kind
    • Snz.t_idling
    • Snz.b_amplitude
    • Snz.i()
    • Snz.model_config
  • ECap
    • ECap.model_config
    • ECap.kind
    • ECap.alpha
    • ECap.i()
  • Custom
    • Custom.model_config
    • Custom.kind
    • Custom.i_
    • Custom.q_
    • Custom.i()
    • Custom.q()
  • Acquisition
    • Acquisition.kind
    • Acquisition.duration
    • Acquisition.model_config
  • Align
    • Align.model_config
    • Align.kind
  • Delay
    • Delay.kind
    • Delay.duration
    • Delay.model_config
  • Pulse
    • Pulse.kind
    • Pulse.duration
    • Pulse.amplitude
    • Pulse.envelope
    • Pulse.relative_phase
    • Pulse.i()
    • Pulse.q()
    • Pulse.envelopes()
    • Pulse.model_config
  • PulseId
  • Readout
    • Readout.kind
    • Readout.model_config
    • Readout.acquisition
    • Readout.probe
    • Readout.from_probe()
    • Readout.duration
    • Readout.id
  • VirtualZ
    • VirtualZ.kind
    • VirtualZ.phase
    • VirtualZ.duration
    • VirtualZ.model_config
  • Qubit
    • Qubit.model_config
    • Qubit.drive
    • Qubit.drive_qudits
    • Qubit.flux
    • Qubit.probe
    • Qubit.acquisition
    • Qubit.channels
    • Qubit.default()
  • PulseSequence
    • PulseSequence.load()
    • PulseSequence.duration
    • PulseSequence.channels
    • PulseSequence.channel()
    • PulseSequence.channel_duration()
    • PulseSequence.pulse_channels()
    • PulseSequence.concatenate()
    • PulseSequence.juxtapose()
    • PulseSequence.align()
    • PulseSequence.align_to_delays()
    • PulseSequence.trim()
    • PulseSequence.acquisitions
  • Parameter
    • Parameter.frequency
    • Parameter.amplitude
    • Parameter.duration
    • Parameter.duration_interpolated
    • Parameter.relative_phase
    • Parameter.offset
    • Parameter.channels()
  • ParallelSweepers
  • Sweeper
    • Sweeper.parameter
    • Sweeper.values
    • Sweeper.range
    • Sweeper.pulses
    • Sweeper.channels
    • Sweeper.check_values()
    • Sweeper.model_config
  • Subpackages
    • qibolab.instruments package