iqm.iqm_client.models

iqm.iqm_client.models#

This module contains the data models used by IQMClient.

Module Attributes

CircuitBatch

Type that represents a list of quantum circuits to be executed together in a single batch.

QubitMapping

Type that represents a qubit mapping for a circuit, i.e. a list of single qubit mappings for all qubits in the circuit.

CircuitMeasurementResults

Measurement results from a single circuit.

CircuitMeasurementResultsBatch

Type that represents measurement results for a batch of circuits.

Functions

get_current_instruction_name(name)

Checks if the instruction name has been deprecated and returns the new name if it is; otherwise, just returns the name as-is.

is_directed_instruction(name)

Checks if the instruction with the given name is directed, i.e. if the instruction is allowed only in the direction defined by the operation loci in the quantum architecture.

is_multi_qubit_instruction(name)

Checks if the instruction with the given name is a multi-qubit instruction.

serialize_qubit_mapping(qubit_mapping)

Serializes a qubit mapping dict into the corresponding IQM data transfer format.

validate_circuit(circuit)

Validates a submitted quantum circuit using Pydantic tooling.

Classes

Circuit(*, name, instructions[, metadata])

Quantum circuit to be executed.

CircuitCompilationOptions([...])

Various discrete options for quantum circuit compilation to pulse schedule.

HeraldingMode(value)

Heralding mode for circuit execution.

Instruction(*, name[, implementation])

The Instruction class represents a native quantum operation.

Metadata(*[, calibration_set_id, ...])

Metadata describing a circuit execution job.

MoveGateFrameTrackingMode(value)

MOVE gate frame tracking mode for circuit compilation.

MoveGateValidationMode(value)

MOVE gate validation mode for circuit compilation.

QuantumArchitecture(*, quantum_architecture)

Quantum architecture as returned by server.

QuantumArchitectureSpecification(*, name, ...)

Quantum architecture specification.

RunRequest(*, circuits[, custom_settings, ...])

Request for an IQM quantum computer to run a job that executes a batch of quantum circuits.

RunResult(*, status[, measurements, ...])

Results of the quantum circuit execution job.

RunStatus(*, status[, message, warnings])

Status of a circuit execution job.

SingleQubitMapping(*, logical_name, ...)

Mapping of a logical qubit name to a physical qubit name.

Status(value)

Status of a job.

Inheritance

Inheritance diagram of iqm.iqm_client.models