Overview
=========

.. raw:: html
   
   <h1 style="text-align: center">
      <img src="../_static/logo.png" alt="qbraid logo" style="width:50px;height:50px;">
      <span> qBraid</span>
      <span style="color:#808080"> | Lab</span>
   </h1>
   <p style="text-align:center;font-style:italic;color:#808080">
      A web-based IDE optimized for quantum computing.
   </p>


`qBraid Lab <https://lab.qbraid.com>`_ 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**.

.. image:: ../_static/getting_started/launcher.png
    :width: 90%
    :alt: Lab interface
    :target: javascript:void(0);
  
|


User Guide
-----------


- `Account <account.html>`_
   - `Add access key <account.html#add-access-key>`_

- `Getting Started <getting_started.html>`_
   - `Launch Lab <getting_started.html#launch-lab>`_
   - `Lab interface <getting_started.html#lab-interface>`_
   - `Lab server <getting_started.html#lab-server>`_

- `Environments <environments.html>`_
   - `Install environment <environments.html#install-environment>`_
   - `Create environment <environments.html#create-environment>`_
   - `Share environment <environments.html#share-environment>`_
   - `Uninstall / cancel install environment <environments.html#uninstall-cancel-install-environment>`_
   - `Install new package <environments.html#install-new-package>`_
   - `Activate environment (kernel) <environments.html#activate-environment-kernel>`_
   - `Command-line usage <environments.html#command-line-usage>`_
   - `Featured environments <environments.html#featured-environments>`_

- `Kernels <kernels.html>`_
   - `Add/remove kernels <kernels.html#add-remove-kernels>`_
   - `Julia <kernels.html#julia>`_
   - `C++ <kernels.html#c++>`_

- `Notebooks <notebooks.html>`_
   - `Create notebook <notebooks.html#create-notebook>`_
   - `Switch notebook kernel <notebooks.html#switch-notebook-kernel>`_
   - `Share noteboook <notebooks.html#share-notebook>`_

- `Quantum Devices <quantum_devices.html>`_
   - `Quantum Devices Sidebar <quantum_devices.html#quantum-devices-sidebar>`_

- `Quantum Jobs <quantum_jobs.html>`_
   - `Credits <quantum_jobs.html#credits>`_
   - `Which environments? <quantum_jobs.html#which-environments>`_
   - `Enable/disable <quantum_jobs.html#enable-disable>`_
   - `Manage <quantum_jobs.html#manage>`_

- `Code Snippets <code_snippets.html>`_
   - `Key Features <code_snippets.html#key-features>`_

- `GPUs <gpu.html>`_
   - `Launch GPU instance <gpu.html#launch-gpu-instance>`_
   - `Configuration <gpu.html#configuration>`_
   - `GPU-enabled environments <gpu.html#gpu-enabled-environments>`_

- `Omnisearch <omnisearch.html>`_
   - `GitHub <omnisearch.html#omnisearch-github>`_
   - `ChatGPT <omnisearch.html#omnisearch-chatgpt>`_

- `Quantum Docs <quantum_docs.html>`_
   - `Browse by company <quantum_docs.html#browse-by-company>`_
   - `Company link page <quantum_docs.html#company-link-page>`_

- `Jupyter Extensions <extensions.html>`_
   - `Filebrowser <extensions.html#filebrowser>`_
   - `Git <extensions.html#git>`_
   - `Resource Usage <extensions.html#resource-usage>`_

- `Integrations <integrations.html>`_
   - `Visual Studio Code <integrations.html#visual-studio-code>`_

- `System Info <system.html>`_
   - `Operating System <system.html#operating-system>`_
   - `Pre-Installed Software <system.html#gnu-packages>`_

- `Troubleshooting <troubleshoot.html>`_
   - `Error launching Lab <troubleshoot.html#error-launching-lab>`_
   - `Lab server errors <troubleshoot.html#lab-server-errors>`_
   - `ModuleNotFoundError <troubleshoot.html#modulenotfounderror>`_
   - `NoRegionError <troubleshoot.html#noregionerror>`_
   - `Extension sidebar errors <troubleshoot.html#extension-sidebar-errors>`_

- `Pricing <pricing.html>`_
   - `Quantum Computers (on-demand) <pricing.html#quantum-computers->`_
   - `Quantum Circuit Simulators <pricing.html#quantum-circuit-simulators>`_
   - `CPUs + GPUs <pricing.html#cpus-gpus>`_

.. seealso::
   
   - `Project Jupyter <https://docs.jupyter.org/en/latest/#jupyter-project-documentation>`_
   - `JupyterLab <https://jupyterlab.readthedocs.io/en/stable/>`_
   - `Jupyter Notebook <https://jupyter-notebook.readthedocs.io/en/latest/notebook.html>`_