BraketSimulatorClient

class BraketSimulatorClient

Bases: QuantumBaseClient[AlgoType, BraketJobMeta, QiskitCircuit]

Client that executes quantum circuits on Amazon Braket simulators.

Supports both local simulators (braket_sv, braket_dm) and managed AWS simulators (SV1, TN1, DM1). Accepts any algorithm conforming to QuantumAlgoProtocol via the algo parameter.

Methods

__init__	Initialize a BraketSimulatorClient.
solve	Call the solver service to solve the given optimization problem.
version	Return the backend version string.

Attributes

acceptable_degrees	Polynomial degrees accepted by the algorithm for the objective and constraints.
algo	The algorithm class used by this client.
device	Name of the target Braket simulator.
provider	Authentication for AWS-managed simulators.
parameters	Algorithm parameters instance.

__init__(

algo: type[AlgoType],

device: Literal['braket_sv', 'braket_dm', 'SV1', 'TN1', 'DM1'] = 'braket_sv',

provider: AwsSession | None = None,

) → None

Initialize a BraketSimulatorClient.

Parameters:

• algo (type[AlgoType]) – The algorithm class to use (e.g., QAOA).

• device (BraketSimulatorName) – Simulator name. One of "braket_sv", "braket_dm", "SV1", "TN1", or "DM1".

• provider (AwsSession | None) – Authentication for AWS-managed simulators ("SV1", "TN1", "DM1"). Set to an braket.aws.AwsSession to configure credentials. Required for on-demand simulators; ignored for local simulators ("braket_sv", "braket_dm").

solve(

objective: Poly | Matrix,

constraints: ConstraintList | None,

dry_run: bool = False,

) → CustomClientResultProtocol | None

Call the solver service to solve the given optimization problem.

Parameters:

• objective (Poly | Matrix) – The objective function to minimize.

• constraints (ConstraintList | None) – Constraints for the problem. If None, no constraints are applied.

• dry_run (bool) – If True, validate inputs without executing circuits and return None.

Returns:

The algorithm result, or None if dry_run is True.

Return type:

CustomClientResultProtocol | None

version() → str

Return the backend version string.

property acceptable_degrees: AcceptableDegrees

Polynomial degrees accepted by the algorithm for the objective and constraints.

property algo: type[AlgoType]

The algorithm class used by this client.

property device: Literal['braket_sv', 'braket_dm', 'SV1', 'TN1', 'DM1']

Name of the target Braket simulator.

parameters

Algorithm parameters instance. The concrete type depends on the algorithm; for QAOA this is QAOA.Parameters. Modify this to configure the algorithm before calling solve().

property provider: AwsSession | None

Authentication for AWS-managed simulators.

Set to an braket.aws.AwsSession to configure credentials. Required for on-demand simulators ("SV1", "TN1", "DM1"); ignored for local simulators ("braket_sv", "braket_dm"). Set to None to clear configured credentials.