Skip to main content

Python SDK for Haiqu quantum cloud — circuit analytics, error mitigation, and hybrid quantum application execution

Project description

Haiqu SDK: Quantum Performance Middleware for Python

Haiqu is a middleware platform that bridges the gap between quantum hardware and practical applications. Haiqu SDK gives you programmatic access to the full Haiqu cloud stack: error mitigation, circuit compression, hardware integration, and experiment tracking - so you can run quantum circuits that actually work on today's noisy hardware.

Haiqu Stack

📖 Full documentation: docs.haiqu.ai

What You Can Do with Haiqu

  • Error Shield: automatic noise reduction preserves circuit fidelity without manual calibration
  • Circuit Compression: run circuits that would otherwise exceed hardware qubit and gate limits
  • Data Loading: linear-depth quantum data loading at practical scale
  • Hardware Integration: connect to major quantum processors and cloud platforms through a single API
  • Experiment Tracking: monitor job history, circuit measurements, and results across runs

For example, using Haiqu SDK for a utility-scale Floquet dynamics simulation of the kicked Ising model on 103 qubits reduces quantum processor runtime from ~3.1 hours to ~1 minute, and lowers the estimated quantum cloud bill from ~$17,856 to ~$34, while preserving accuracy close to the ideal result.

Kicked Ising Pareto Plot

See the kicked_ising.ipynb notebook for the full experiment, as well as other SDK Application notebooks in the sdk-examples repository for more cases of practical advantage.

Want to see this in action? Book a demo to get access to this example and more.

Research results

Haiqu's technology is backed by peer-reviewed research:

See also the Haiqu Blog for more exciting research from us.

Installation

This repository contains the source code for the Haiqu SDK Python package. For users, It is recommended to install it from PyPI via pip install haiqu-sdk rather than to build from source. Refer to Haiqu SDK Docs / Local Installation guide for more details.

[!TIP] Alternatively, you can request access to Haiqu Lab: a pre-built, hosted JupyterLab environment with everything pre-installed and no local setup required. This can be done through your Haiqu account after sign-up.

Prerequisites

  • Python 3.10+ or Conda

Step 1: Set up a Python environment (recommended)

Creating a virtual environment is optional, but highly recommended to avoid system-wide install and update of package dependencies.

Venv (available by default with Python)

python -m venv haiqu-env
source haiqu-env/bin/activate

Note: on Windows systems, instead of the shell command on the last line above, run .\haiqu-env\Scripts\activate.bat to activate the environment.


Conda

conda create -y --name haiqu-sdk python=3.13
conda activate haiqu-sdk

Virtualenv

virtualenv haiqu-env --python ">=3.10"
source haiqu-env/bin/activate

Step 2: Install the SDK

The latest version is available from PyPI

pip install haiqu-sdk

Getting Access

To use the Haiqu SDK you need an API key.

Request access here → haiqu.ai

After sign-up, your API key and access instructions will be delivered by email.

Once you have a key, authenticate in your code:

from haiqu.sdk import haiqu
  
# Login with your API key
haiqu.login(api_access_key="ENTER_YOUR_API_KEY_HERE")  # or set the HAIQU_API_KEY env variable
  
# Initialize your first experiment
haiqu.init("My First Quantum Experiment")

On success you will see:

Success: Welcome to the Quantum World, you@example.com!

You're all set. Refer to the Getting Started section to learn what you can do with Haiqu SDK.

Getting Started

The fastest way to get started is through the SDK tutorial notebooks in the sdk-examples repository. They act as a tutorial for basic Haiqu SDK feature with ready-to-run notebooks. Clone it and open the notebooks in your environment to get started:

git clone https://github.com/haiqu-ai/sdk-examples.git
cd sdk-examples

Also see the Core Features section of the Haiqu SDK docs for guides, as well as the full Haiqu SDK Reference.

AI-Assisted Development (MCP)

Haiqu exposes MCP (Model Context Protocol) servers so you can use AI assistants like Claude or Cursor to execute circuits, query results, and browse documentation directly from your editor.

See MCP.md for configuration instructions for VS Code + Claude Code and Cursor.

Feedback and Support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

haiqu_sdk-1.4.0.tar.gz (157.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

haiqu_sdk-1.4.0-py3-none-any.whl (167.3 kB view details)

Uploaded Python 3

File details

Details for the file haiqu_sdk-1.4.0.tar.gz.

File metadata

  • Download URL: haiqu_sdk-1.4.0.tar.gz
  • Upload date:
  • Size: 157.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for haiqu_sdk-1.4.0.tar.gz
Algorithm Hash digest
SHA256 3b5af3091faeeba9bff68bb1d09429a61a4919da50380dc04a5ad813749fc507
MD5 030907d96e130356390f3dee59ccd7d2
BLAKE2b-256 9db77915b21fb302892e1e5c5db1d51bb5d32c342c3ba6c3551c9d8107a01906

See more details on using hashes here.

File details

Details for the file haiqu_sdk-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: haiqu_sdk-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 167.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for haiqu_sdk-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc02b9936cb72f64fac7931e078a301a77b3f6f2e75d11ecc02b8ee6e8360158
MD5 e1391067ed26e6aee10bbca2ec89ac37
BLAKE2b-256 499a58f14e4e669a2628d6a90682af721253eb7f1dd6aa5cee529ff92629cb45

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page