Qiskit Code Assistant (Beta) Jupyterlab Extension

A JupyterLab extension for Qiskit Code Assistant

You can also use the VSCode extension if you dont have access to Jupyterlab

This extension is composed of a Python package named qiskit_code_assistant_jupyterlab for the server extension and a NPM package named qiskit-code-assistant-jupyterlab for the frontend extension.

Requirements

• JupyterLab >= 4.3.0
• Access to either:
  • An IBM Quantum premium account
  • A local LLM service (e.g., Ollama with Qiskit models)
  • A service exposing LLMs using OpenAI-compatible API endpoints

Install

To install the extension, execute:

pip install qiskit_code_assistant_jupyterlab

Quick Start

Option 1: IBM Quantum Cloud (Recommended)

Use IBM's hosted service with a premium account for the best experience:

1. Get your API token from IBM Quantum
2. Start JupyterLab: jupyter lab
3. Click the status bar when prompted and enter your API token
4. Select a model

See GETTING_STARTED.md for detailed setup instructions.

Option 2: Local Setup (For Non-Premium Users)

If you don't have an IBM Quantum Premium account, run the Qiskit Code Assistant entirely on your local machine:

bash <(curl -fsSL https://raw.githubusercontent.com/Qiskit/qiskit-code-assistant-jupyterlab/main/setup_local.sh)

For automated/CI setups, use non-interactive mode:

bash setup_local.sh --non-interactive
# Or: bash setup_local.sh -y

This one command will:

• Detect and use uv for faster installations (if available)
• Check and optionally install JupyterLab
• Always upgrade the extension to the latest version
• Install and configure Ollama
• Download the Qwen2.5-Coder 14B model (optimized for Qiskit)
• Set up the JupyterLab extension automatically

Note: Requires Python 3.8+ and 16GB+ RAM for optimal performance. For faster installations, consider installing uv.

For detailed instructions, see LOCAL_SETUP.md.

Uninstall

To remove the extension, execute:

pip uninstall qiskit_code_assistant_jupyterlab

Using the Qiskit Code Assistant

• Local Setup: See LOCAL_SETUP.md for running models locally with Ollama
• Cloud Setup: See GETTING_STARTED.md for using IBM Quantum Cloud

Contributing

To learn more about contributing or installing locally read CONTRIBUTING.

Qiskit Code Assistant Terms of use

• End User License Agreement (EULA) acceptance required before starting to use the model acceptance required before starting to use the model
• Terms of use: https://quantum.ibm.com/terms
• Privacy policy: https://quantum.ibm.com/terms/privacy
• Cloud Services Agreement https://www.ibm.com/support/customer/csol/terms/?id=Z126-6304&cc=us&lc=en
• IBM Cloud Service Description https://www.ibm.com/support/customer/csol/terms/?id=i126-6605&lc=en