- The qBraid Lab User Guide can now be found at: https://docs.qbraid.com/lab
- To submit feature requests or file bug reports, please visit our community page: https://github.com/qBraid/community
qBraid Lab is a web-based JupyterLab deployment providing curated software tools for for researchers and developers in quantum computing.
- Hosts 30+ configurable quantum software environments in Python, Julia, C++, and Q#.
- Integrates with GitHub, VSCode, ChatGPT, and more.
- Collaborative tools enable sharing notebooks, environments, and code snippets.
- Provides direct access to a robust suite of computing resources, encompassing scalable CPUs, GPUs, and QPUs.
qBraid Lab and its extensions are proprietary and closed source. However, this repository hosts the Sphinx documentation source as open-source, licensed under Apache-2.0, to enable community members to contribute to, revise, and enhance the documentation. Additionally, this repository serves as a platform for tracking community feature requests and bug reports.
- For topics related to qBraid-Lab, please open an issue here.
- For topics related to qBraid-SDK, please open an issue here.
- For topics related to qBraid-QIR, please open an issue here.
- For topics related to account, qbook, or other qBraid services, please open an issue here.
To use qBraid Lab, you must first sign in or create an account →.
Use the drop-down at the top of your account page to select a Lab image. All users have access to the "Free" tier image, which includes 2 virtual CPUs and 4 GB of RAM. Paid subscription tiers include compute options ranging up to 10 virtual CPUs, GPU images, and application specific images such as Bloqade. Once you have selected an image, click Launch Lab.
Once your image is pulled, you will be taken to the qBraid Lab interface. Here are a few helpful resources to get started:
- Interactive tour: Click Start Tour (bottom right) to begin a guided tour of all of the Lab extensions and their key features.
- qBraid tutorials: The
qbraid-tutorialsdirectory (left-sidebar FILES tab) contains examples and tutorials for a wide range different quantum software packages. Many of the notebooks contain qBraid instructions and are runnable using thePython 3 [Default]environment. - qBraid Docs: The Quantum Docs extension (bottom middle of Launcher, under Other) contains a collection of direct links to documentation pages for many of the most popular quantum software packages.
- Help drop-down: The top-bar menu Help drop-down contains links to more qBraid user guides, demos, and reference materials.
The "Launch on qBraid" button (below) can be added to any public GitHub
repository. Clicking on it automaically opens qBraid Lab, and performs a
git clone of the project repo into your account's home directory. Copy the
code below, and replace YOUR-USERNAME and YOUR-REPOSITORY with your GitHub
info.
Use the badge in your project's README.md:
[<img src="https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png" width="150">](https://account.qbraid.com?gitHubUrl=https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git)Use the badge in your project's README.rst:
.. image:: https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png
:target: https://account.qbraid.com?gitHubUrl=https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git
:width: 150px- Interested in contributing to the project, or making a PR? See CONTRIBUTING.md
- For feature requests and bug reports: Submit an issue
- For discussions, and specific questions about the qBraid SDK, qBraid Lab, or other topics, join our discord community
- For questions that are more suited for a forum, post to
Quantum Computing Stack Exchange
with the
qbraidtag. - Want your open-source project featured as its own runtime environment on qBraid Lab? Fill out our New Environment Request Form