---

⚠️ PLEASE NOTE: As of June 28, 2024 this repository has been deprecated, and is no longer in use.

• 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.

Features

• 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.

Resources

• Developer documentation
• Example notebooks
• Project Jupyter
• JupyterLab
• Jupyter Notebook

This repository

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.

Getting started

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-tutorials directory (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 the Python 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.

User Guide

• Account

  • Add access key

• Getting Started

  • Launch Lab
  • Lab interface
  • Lab server

• Environments

  • Install environment
  • Create environment
  • Share environment
  • Uninstall / cancel install environment
  • Install new package
  • Activate environment (kernel)
  • Command-line usage
  • Featured environments

• Kernels

  • Add/remove kernels
  • Julia
  • C++

• Notebooks

  • Create notebook
  • Switch notebook kernel
  • Share notebook

• Quantum Devices

  • Quantum Devices Sidebar

• Quantum Jobs

  • Credits
  • Which environments?
  • Enable/disable
  • Manage

• Code Snippets

  • Key Features

• GPUs

  • Launch GPU instance
  • Configuration
  • GPU-enabled environments

• Omnisearch

  • GitHub
  • ChatGPT

• Quantum Docs

  • Browse by company
  • Company link page

• Jupyter Extensions

  • Filebrowser
  • Git
  • Resource Usage

• Integrations

  • Visual Studio Code

• System Info

  • Operating System
  • Pre-Installed Software

• Troubleshooting

  • Error launching Lab
  • Lab server errors
  • ModuleNotFoundError
  • NoRegionError
  • Extension sidebar errors

• Pricing

  • Quantum Computers
  • Quantum Circuit Simulators
  • CPUs + GPUs

Launch on qBraid

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

Contributing

• 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 qbraid tag.
• Want your open-source project featured as its own runtime environment on qBraid Lab? Fill out our New Environment Request Form

License

Apache License 2.0