qcs_sdk.qvm.api

 1# This file is automatically generated by pyo3_stub_gen
 2# ruff: noqa: F401
 3
 4from qcs_sdk._qcs_sdk.qvm.api import (
 5    AddressRequest,
 6    ExpectationRequest,
 7    MultishotMeasureRequest,
 8    MultishotRequest,
 9    MultishotResponse,
10    WavefunctionRequest,
11    get_version_info,
12    get_version_info_async,
13    get_wavefunction,
14    get_wavefunction_async,
15    measure_expectation,
16    measure_expectation_async,
17    run,
18    run_and_measure,
19    run_and_measure_async,
20    run_async,
21)
22
23__all__ = [
24    "AddressRequest",
25    "ExpectationRequest",
26    "MultishotMeasureRequest",
27    "MultishotRequest",
28    "MultishotResponse",
29    "WavefunctionRequest",
30    "get_version_info",
31    "get_version_info_async",
32    "get_wavefunction",
33    "get_wavefunction_async",
34    "measure_expectation",
35    "measure_expectation_async",
36    "run",
37    "run_and_measure",
38    "run_and_measure_async",
39    "run_async",
40]
class AddressRequest:

An enum encapsulating the different ways to request data back from the QVM for an address.

class AddressRequest.IncludeAll(qcs_sdk.qvm.api.AddressRequest):

Get all values for the address.

class AddressRequest.ExcludeAll(qcs_sdk.qvm.api.AddressRequest):

Exclude all values for the address.

class AddressRequest.Indices(qcs_sdk.qvm.api.AddressRequest):

A list of specific indices to get back for the address.

class ExpectationRequest:

The request body needed for a [measure_expectation] request to the QVM.

operators

A list of Pauli operators to measure.

rng_seed

An optional seed for the random number generator.

state_preparation

A Quil program defining the state.

class MultishotMeasureRequest:

The request body needed for a [run_and_measure] request to the QVM.

rng_seed

An optional seed for the random number generator.

measurement_noise

Simulated measurement noise for the X, Y, and Z axes.

qubits

Qubits to measure

compiled_quil

The Quil program to run.

trials
gate_noise

Simulated gate noise for the X, Y, and Z axes.

class MultishotRequest:

The request body needed to make a multishot [run] request to the QVM.

trials
measurement_noise

Simulated measurement noise for the X, Y, and Z axes.

compiled_quil

The Quil program to run.

addresses

The memory regions to include in the response.

gate_noise

Simulated gate noise for the X, Y, and Z axes.

rng_seed

An optional seed for the random number generator.

class MultishotResponse:

The response body returned by the QVM after a multishot [run] request.

registers

The requested readout registers and their final values for each shot.

class WavefunctionRequest:

The request body needed to make a [get_wavefunction] request to the QVM.

measurement_noise

Simulated measurement noise for the X, Y, and Z axes.

compiled_quil

The Quil program to run.

rng_seed

An optional seed for the random number generator.

gate_noise

Simulated gate noise for the X, Y, and Z axes.

def get_version_info(client, options=None):
def get_version_info_async(client, options=None):
def get_wavefunction(request, client, options=None):
def get_wavefunction_async(request, client, options=None):
def measure_expectation(request, client, options=None):
def measure_expectation_async(request, client, options=None):
def run(request, client, options=None):
def run_and_measure(request, client, options=None):
def run_and_measure_async(request, client, options=None):
def run_async(request, client, options=None):