START NOW
User Guide

Overview

qBraid-CORE

Python client for developing software with qBraid cloud services

qBraid-CORE is a Python library providing core abstractions for software development within the qBraid ecosystem, and a low-level interface to a growing array of qBraid cloud services. The qbraid-core package forms the foundational base for the qBraid CLI, the qBraid SDK, and the qBraid Lab.

You can find the latest, most up to date, documentation here, including a list of services that are supported.

Getting Started

You can install qbraid-core from PyPI with:

pip install qbraid-core

qbraid-core versions <0.2.0 are not compatible with qBraid API V2. See migration guide.

To ensure compatibility with the new platform, use qbraid-core ≥ 0.2.0.

Local configuration

After installing qbraid-core, you must configure your account credentials:

  1. Create a qBraid account or log in to your existing account by visiting account.qbraid.com
  2. Navigate to Account > API Keys in the left-sidebar, and then click “Create API Key”.
  3. Save your API key from step 2 in local configuration file ~/.qbraid/qbraidrc, where ~ corresponds to your home ($HOME) directory:
[default]
api-key = YOUR_KEY
url = https://api-v2.qbraid.com/api/v1

Or generate your ~/.qbraid/qbraidrc file via the qbraid-core Python interface:

>>> from qbraid_core import QbraidSessionV1
>>> session = QbraidSessionV1(api_key='API_KEY')
>>> session.save_config()

Other credential configuration methods can be found here.

Verify setup

After configuring your qBraid credentials, verify your setup by running the following from a Python interpreter:

>>> from qbraid_core.services.runtime import QuantumRuntimeClient
>>> quantum_client = QuantumRuntimeClient()
>>> device_list = quantum_client.list_devices()
>>> for device in device_list:
...     print(device.qrn)

Community