devices

Client API for devices in Nexus.

enum qnexus.client.devices.DeviceStateEnum(

value,

)

Quantinuum Systems Device status enum.

Member Type:

str

Valid values are as follows:

ONLINE = <DeviceStateEnum.ONLINE: 'online'>

OFFLINE = <DeviceStateEnum.OFFLINE: 'offline'>

MAINTENANCE = <DeviceStateEnum.MAINTENANCE: 'in maintenance'>

RESERVED_ONLINE = <DeviceStateEnum.RESERVED_ONLINE: 'online, reserved'>

RESERVED_MAINTENANCE = <DeviceStateEnum.RESERVED_MAINTENANCE: 'in maintenance, reserved'>

RESERVED_OFFLINE = <DeviceStateEnum.RESERVED_OFFLINE: 'offline, reserved'>

qnexus.client.devices.expectation_allows_nonhermitian(

backend_config: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig | SeleneQuestConfig | SeleneStimConfig | SeleneLeanConfig | SeleneCoinFlipConfig | SeleneClassicalReplayConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')],

) → bool

Does the backend configuration support expectation_allows_nonhermitian?

qnexus.client.devices.get_all(

issuers: list[IssuerEnum] | None = None,

aws_region: str | None = None,

ibmq_hub: str | None = None,

ibmq_group: str | None = None,

ibmq_project: str | None = None,

credentials: list[Credential] | None = None,

credential_names: list[str] | None = None,

nexus_hosted: bool | None = None,

) → DataframableList[Device]

Get all available devices.

qnexus.client.devices.status(

backend_config: QuantinuumConfig,

) → DeviceStateEnum

Get the status of a hardware-hosted Quantinuum Systems device, such as whether is it online or offline.

Please note this operation is not supported for cloud-hosted emulators, which can be assumed to be always online.

qnexus.client.devices.supports_contextual_optimisation(

backend_config: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig | SeleneQuestConfig | SeleneStimConfig | SeleneLeanConfig | SeleneCoinFlipConfig | SeleneClassicalReplayConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')],

) → bool

Does the backend configuration support TKET contextual optimization?

qnexus.client.devices.supports_counts(

backend_config: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig | SeleneQuestConfig | SeleneStimConfig | SeleneLeanConfig | SeleneCoinFlipConfig | SeleneClassicalReplayConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')],

) → bool

Does the backend configuration support shots?

qnexus.client.devices.supports_density_matrix(

backend_config: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig | SeleneQuestConfig | SeleneStimConfig | SeleneLeanConfig | SeleneCoinFlipConfig | SeleneClassicalReplayConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')],

) → bool

Does the backend configuration support density matrix results?

qnexus.client.devices.supports_expectation(

backend_config: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig | SeleneQuestConfig | SeleneStimConfig | SeleneLeanConfig | SeleneCoinFlipConfig | SeleneClassicalReplayConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')],

) → bool

Does the backend configuration support expectation values?

qnexus.client.devices.supports_shots(

backend_config: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig | SeleneQuestConfig | SeleneStimConfig | SeleneLeanConfig | SeleneCoinFlipConfig | SeleneClassicalReplayConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')],

) → bool

Does the backend configuration support shots?

qnexus.client.devices.supports_state(

backend_config: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig | SeleneQuestConfig | SeleneStimConfig | SeleneLeanConfig | SeleneCoinFlipConfig | SeleneClassicalReplayConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')],

) → bool

Does the backend configuration support statevector results?

qnexus.client.devices.supports_unitary(

backend_config: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig | SeleneQuestConfig | SeleneStimConfig | SeleneLeanConfig | SeleneCoinFlipConfig | SeleneClassicalReplayConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')],

) → bool

Does the backend configuration support a unitary?

class qnexus.devices.Device(

*,

backend_name: str,

device_name: str | None,

nexus_hosted: bool,

stored_backend_info: StoredBackendInfo,

)

A device in Nexus.

df() → DataFrame

Present in a pandas DataFrame.