qcs_sdk.qpu.api

class Register:
def from_i32(inner):

The Python wrapper for [Register::I32], creating a [PyRegister] and taking a Python argument.

def from_complex32(inner):

The Python wrapper for [Register::Complex32], creating a [PyRegister] and taking a Python argument.

def inner(self, /):

Directly return the Python version of the variant discriminant wrapped by this value; i.e., performs the match Register::Variant(x) => x for every variant constructor in [Register]

def is_i32(self, /):

Tests if this [PyRegister] wraps a [Register::i32] value

def as_i32(self, /):

Returns x if this [PyRegister] wraps a Register::i32(x); otherwise returns (Python) None. On the Rust side, this corresponds to either Some(x) or [None].

def to_i32(self, /):

Returns x if this [PyRegister] wraps a Register::i32(x); otherwise raises a ValueError. On the Rust side, this corresponds to either Ok(x) or Err(...).

def is_complex32(self, /):

Tests if this [PyRegister] wraps a [Register::complex32] value

def as_complex32(self, /):

Returns x if this [PyRegister] wraps a Register::complex32(x); otherwise returns (Python) None. On the Rust side, this corresponds to either Some(x) or [None].

def to_complex32(self, /):

Returns x if this [PyRegister] wraps a Register::complex32(x); otherwise raises a ValueError. On the Rust side, this corresponds to either Ok(x) or Err(...).

class ExecutionResult:

The execution readout data from a particular memory location.

def from_register(register):
shape

Describes result shape dimensions.

data

Register data for this result.

dtype

Name of the data type.

class ExecutionResults:
buffers

Result data buffers keyed by readout alias name.

execution_duration_microseconds

QPU execution duration.

memory
class ConnectionStrategy:
def default():
def gateway():
def is_gateway(self, /):
def direct_access():
def is_direct_access(self, /):
def endpoint_id(endpoint_id):
def is_endpoint_id(self, /):
def get_endpoint_id(self, /):
class ExecutionOptions:
def default():
def builder():
api_options
connection_strategy
timeout_seconds
class ExecutionOptionsBuilder:
def default():
def build(self, /):
timeout_seconds
api_options
connection_strategy
class APIExecutionOptions:
def default():
def builder():
bypass_settings_protection
class APIExecutionOptionsBuilder:
def default():
def build(self, /):
bypass_settings_protection
class SubmissionError(builtins.RuntimeError):

Unspecified run-time error.

class QpuApiError(builtins.RuntimeError):

Unspecified run-time error.

def submit( program, patch_values, quantum_processor_id=None, client=None, execution_options=None):

Submits an executable program to be run on the specified QPU

Errors

May return an error if

  • an engagement is not available
  • an RPCQ client cannot be built
  • the program cannot be submitted
def submit_async( program, patch_values, quantum_processor_id=None, client=None, execution_options=None):

Submits an executable program to be run on the specified QPU

Errors

May return an error if

  • an engagement is not available
  • an RPCQ client cannot be built
  • the program cannot be submitted
def submit_with_parameter_batch( program, patch_values, quantum_processor_id=None, client=None, execution_options=None):
def submit_with_parameter_batch_async( program, patch_values, quantum_processor_id=None, client=None, execution_options=None):
def cancel_job( job_id, quantum_processor_id=None, client=None, execution_options=None):
def cancel_job_async( job_id, quantum_processor_id=None, client=None, execution_options=None):
def cancel_jobs( job_ids, quantum_processor_id=None, client=None, execution_options=None):
def cancel_jobs_async( job_ids, quantum_processor_id=None, client=None, execution_options=None):
def retrieve_results( job_id, quantum_processor_id=None, client=None, execution_options=None):
def retrieve_results_async( job_id, quantum_processor_id=None, client=None, execution_options=None):