qcs_sdk.qpu 

 1# This file is automatically generated by pyo3_stub_gen
 2# ruff: noqa: F401
 3
 4from qcs_sdk._qcs_sdk.qpu import (
 5    ListQuantumProcessorsError,
 6    MemoryValues,
 7    QPUResultData,
 8    RawQPUReadoutData,
 9    ReadoutValues,
10    api,
11    experimental,
12    isa,
13    list_quantum_processors,
14    list_quantum_processors_async,
15    translation,
16)
17
18__all__ = [
19    "ListQuantumProcessorsError",
20    "MemoryValues",
21    "QPUResultData",
22    "RawQPUReadoutData",
23    "ReadoutValues",
24    "api",
25    "experimental",
26    "isa",
27    "list_quantum_processors",
28    "list_quantum_processors_async",
29    "translation",
30]
class ListQuantumProcessorsError(qcs_sdk._qcs_sdk.QcsSdkError):

API Errors encountered when trying to list available quantum processors.

class MemoryValues:

A row of data containing the contents of a memory region at the end of a job.

There is a variant for each possible type the memory region could be.

def inner(self, /):
class MemoryValues.Binary(qcs_sdk.qpu.MemoryValues):

Values that correspond to a memory region declared with the BIT or OCTET data type.

class MemoryValues.Integer(qcs_sdk.qpu.MemoryValues):

Values that correspond to a memory region declared with the INTEGER data type.

class MemoryValues.Real(qcs_sdk.qpu.MemoryValues):

Values that correspond to a memory region declared with the REAL data type.

class QPUResultData:

Encapsulates data returned from the QPU after executing a job.

QpuResultData contains "mappings", which map declared memory regions in a program (ie. "ro[0]") to that region's readout key in QpuResultData.readout_values. readout_values maps those readout keys to the values emitted for that region across all shots.

Read more about QPU readout data in the QCS Documentation

def to_raw_readout_data(self, /):

Get the raw readout data as a flattened structure.

def to_register_map(self, /):

Convert into a [RegisterMap].

The [RegisterMatrix] for each register will be constructed such that each row contains all the final values in the register for a single shot.

Errors

Returns a [RegisterMatrixConversionError] if the execution data for any of the registers would result in a jagged matrix. [QpuResultData] data is captured per measure, meaning a value is returned for every measure to a memory reference, not just once per shot.

This is often the case in programs that use mid-circuit measurement or dynamic control flow, where measurements to the same memory reference might occur multiple times in a shot, or be skipped conditionally. In these cases, building a rectangular [RegisterMatrix] would necessitate making assumptions about the data that could skew the data in undesirable ways. Instead, it's recommended to manually build a matrix from [QpuResultData] that accurately selects the last value per-shot based on the program that was run.

readout_values

Mapping of a readout values identifier (ie. "q0") to a set of ReadoutValues.

memory_values

The final contents of each memory region, keyed on region name.

mappings

Mappings of a memory region (ie. "ro[0]") to its key name in readout_values (ie. "q0").

class RawQPUReadoutData:

A wrapper type for data returned by the QPU in a more flat structure than [QpuResultData] offers. This makes it more convenient to work with the data if you don't care what type of number the readout values for each register contains.

readout_values
mappings
memory_values
class ReadoutValues:

A row of readout values from the QPU.

Each row contains all the values emitted to a memory reference across all shots. There is a variant for each possible type the list of readout values could be.

def inner(self, /):
class ReadoutValues.Integer(qcs_sdk.qpu.ReadoutValues):

Integer readout values

class ReadoutValues.Real(qcs_sdk.qpu.ReadoutValues):

Real numbered readout values

class ReadoutValues.Complex(qcs_sdk.qpu.ReadoutValues):

Complex readout values

def list_quantum_processors(client=None, timeout=None):

Returns all available Quantum Processor (QPU) IDs.

Parameters
  • client: The Qcs client to use. Creates one using environment configuration if unset - see https: //docs.rigetti.com/qcs/references/qcs-client-configuration
  • timeout: Maximum duration to wait for API calls to complete, in seconds.
Raises
  • ListQuantumProcessorsError: If the request to list available QPU IDs failed.
def list_quantum_processors_async(client=None, timeout=None):

Returns all available Quantum Processor (QPU) IDs.

Parameters
  • client: The Qcs client to use. Creates one using environment configuration if unset - see https: //docs.rigetti.com/qcs/references/qcs-client-configuration
  • timeout: Maximum duration to wait for API calls to complete, in seconds.
Raises
  • ListQuantumProcessorsError: If the request to list available QPU IDs failed.