qbraid

This top level module contains the main qBraid public functionality.

Data Types

QPROGRAM

alias of Union[Circuit, QuantumCircuit, QuantumTape, Program, Circuit, Circuit, Program]

QDEVICE

alias of Union[IBMBackend, IBMBackend, AwsDevice]

Functions

about()

Displays information about qBraid, core/optional packages, and Python version/platform information.

get_devices([filters, refresh])

Displays a list of all supported devices matching given filters, tabulated by provider, name, and qBraid ID.

refresh_devices()

Refreshes status for all qbraid supported devices.

circuit_wrapper(program)

Apply qbraid quantum program wrapper to a supported quantum program.

device_wrapper(device_id)

Apply qbraid device wrapper to device from a supported device provider.

job_wrapper(qbraid_job_id)

Retrieve a job from qBraid API using job ID and return job wrapper object.

get_jobs([filters, refresh, raw, session])

Displays a list of quantum jobs submitted by user, tabulated by job ID, the date/time it was submitted, and status.

get_program_type(program[, require_supported])

Get the type of a quantum program.

Classes

LazyLoader(module_name, parent_globals)

Lazily loads a module upon attribute access.

Exceptions

QbraidError

Base class for errors raised by qBraid.

PackageValueError(package)

Class for errors raised due to unsupported quantum frontend package

ProgramTypeError(program)

Class for errors raised when processing unsupported quantum programs

QasmError

For errors raised while processing OpenQASM programs.