QCI Connect Software Development Kit (SDK)

The software development kit (SDK) of the QCI Connect platform is a suite of tools to

• programmatically access its resources (QPUs and HPC simulators),
• conveniently develop applications with abstracted classes,
• locally run and develop algorithms and applications,
• prototype them with the same interface as the platform, and
• prepare them for being made available on the platform.

This release contains the five components qciconnect.common, qciconnect.client, qciconnect.alf, qciconnect.applib and qciconnect.miniserver.

Documentation

You can find more information and technical documentations of the components via the QCI Connect SDK landing page.

Quick Start

Pip Installation

The easiest way to install the SDK is via

pip install qciconnect

The SDK components can also be installed separately via

pip install qciconnect-alf
pip install qciconnect-applib
pip install qciconnect-client
pip install qciconnect-miniserver

Tutorial Notebooks for your Use Case

I want to connect to QCI Connect QPUs, Simulators and Compilers

• Connect to QCI Connect with the API Client
• Use the ALF interfaces for sampling und estimating both locally and on QCI Connect

I want to develop Compilers for QCI Connect

• Build and run your compilers locally on the miniserver
• Access them with the API Client

I want to use/create Error Mitigation Schemes

• Use the mitigation samplers/estimators in ALF

I want to create Quantum Applications

• Build Apps based on ALF

I want to use existing Quantum Applications

• Check out the tutorial notebooks for the core AppLib

Working on Source Code (Dev Mode)

Clone the repository (or download the .tar.gz file), initialize the git submodules, then install dependencies.

We recommend using ultraviolet (installation guide).

git submodule update --init
uv sync
git submodule foreach "uv pip install -e ."

This installs the project, its runtime and development dependencies, and the QCIConnect submodules as editable local dependencies. Recursive submodule initialization is not required. For example, the client submodule uses the root checkout at submodules/qciconnect/common, not a nested checkout below submodules/qciconnect/client.

You can now activate the .venv in the source directory or use uv to run commands in the .venv, e. g., uv run --no-sync python my_script.py.

Be careful: every time you run uv sync to update the venv, the local submodules need to be reinstalled again (git submodule foreach "uv pip install -e ."); otherwise, the venv would use the latest releases on PyPI instead of the local submodules, so any custom changes or checkouts you do in the submodules would be invisible to the venv.

To avoid typing out both commands, you can run the script update-venv from within the activated venv (the script is provided via qciconnect-common). It performs both steps at once and provides options to exclude (--exclude <submodule_list>) specific submodules.

In short: every time you would typically run uv sync, you should instead run

update-venv