Metadata-Version: 2.4
Name: qciconnect
Version: 0.9.0
Summary: The official SDK to the DLR's quantum computing platform QCI Connect.
Keywords: quantum computing, SDK, Software Development Kit, QCI Connect
Author: DLR-SC, David da Costa, Elisabeth Lobe, Thomas Keitzl, Johannes Renkl, Gary Schmiedinghoff, Thomas Stehle, Lukas Windgätter
Author-email: DLR-SC <qc-software@dlr.de>
License-Expression: MIT
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Operating System :: OS Independent
Requires-Dist: bitarray>=3.4.3
Requires-Dist: docker<8,>=7.1.0
Requires-Dist: fastapi==0.110.3
Requires-Dist: flower==2.0.1
Requires-Dist: grpcio-tools>=1.74.0
Requires-Dist: grpcio>=1.76.0
Requires-Dist: httpx<0.29,>=0.28.1
Requires-Dist: matplotlib>=3.10.3
Requires-Dist: networkx>=3.5
Requires-Dist: notebook>=7.4.4
Requires-Dist: numpy<3,>=2.0.0
Requires-Dist: platformdirs>=4.9.2
Requires-Dist: pydantic-settings>=2.4.0
Requires-Dist: pydantic<3,>=2.10.6
Requires-Dist: pyyaml<7,>=6.0.2
Requires-Dist: qiskit-qasm3-import>=0.6.0
Requires-Dist: qiskit>=2.1.0
Requires-Dist: sqlmodel==0.0.19
Requires-Dist: tabulate<0.10,>=0.9.0
Requires-Dist: typeguard>=4.4.4
Requires-Dist: uvicorn<1,>=0.29.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# QCI Connect Software Development Kit (SDK)

The software development kit (SDK) of the [QCI Connect](https://connect.qci.dlr.de) 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

Users with access to QCI Connect can find more information and the __online documentation__ via the [QCI Connect SDK landing page](https://landing-page-026f64.pages.gitlab.dlr.de/).

## Installation via PyPI

The easiest way to install the SDK is via

```
pip install qciconnect
```

The SDK components can also be installed separately via

```
pip install qciconnect-client
```

## Working on Source Code

Clone the repository (or download the `.tar.gz` file) and initialize all submodules, then install dependencies and activate the virtual environment. 
We recommend using [ultraviolet](https://docs.astral.sh/uv) ([installation guide](https://docs.astral.sh/uv/getting-started/installation/#installation-methods)).

```bash
git submodule update --init
uv sync
source .venv/bin/activate
```