Skip to content

device

Core module for oqtopus-client.

Classes:

OqtopusDevice dataclass 

OqtopusDevice(raw: DevicesDeviceInfo)

Public device object wrapper.

Attributes:

  • available_at (datetime | None) –

    Estimated next available time, if provided.

  • basis_gates (list[str]) –

    Supported basis gates.

  • calibrated_at (datetime | None) –

    Last calibration timestamp, if provided.

  • description (str) –

    Human-readable device description.

  • device_id (str) –

    Unique device identifier.

  • device_info (dict[str, object] | None) –

    Additional device information as a parsed dictionary.

  • device_info_str (str | None) –

    Additional device information as raw JSON text.

  • device_type (str) –

    Device type string returned by the API.

  • n_pending_jobs (int) –

    Number of queued jobs for this device.

  • n_qubits (int | None) –

    Qubit count, when available.

  • status (str) –

    Current availability status.

  • supported_instructions (list[str]) –

    Supported instruction set names.

available_at property 

available_at: datetime | None

Estimated next available time, if provided.

This is useful when a device is busy or under maintenance and the API reports an expected recovery time.

basis_gates property 

basis_gates: list[str]

Supported basis gates.

Use this list to understand which transpiled instruction set the device accepts natively.

calibrated_at property 

calibrated_at: datetime | None

Last calibration timestamp, if provided.

This helps assess how recently the hardware calibration data was updated.

description property 

description: str

Human-readable device description.

This is intended for display in UIs and logs rather than as a stable key.

device_id property 

device_id: str

Unique device identifier.

This value is used when submitting jobs to a specific backend.

device_info property 

device_info: dict[str, object] | None

Additional device information as a parsed dictionary.

The API returns this field as JSON text. This property parses that payload into a dictionary for easier consumption.

device_info_str property 

device_info_str: str | None

Additional device information as raw JSON text.

Use this property when you need the original API payload without JSON parsing or when inspecting malformed values returned by the backend.

device_type property 

device_type: str

Device type string returned by the API.

Typical values distinguish hardware and simulator-style backends.

n_pending_jobs property 

n_pending_jobs: int

Number of queued jobs for this device.

This can help estimate queue pressure across multiple candidate devices.

n_qubits property 

n_qubits: int | None

Qubit count, when available.

Some backends may omit this value when the information is not published.

status property 

status: str

Current availability status.

Use this field to check whether the device is available or temporarily unavailable before job submission.

supported_instructions property 

supported_instructions: list[str]

Supported instruction set names.

These values summarize higher-level instruction families supported by the backend.