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: qciconnect-common>=0.3.0
Requires-Dist: qciconnect-client>=1.1.0
Requires-Dist: qciconnect-miniserver>=0.3.0
Requires-Dist: qciconnect-alf>=0.2.0
Requires-Dist: qciconnect-applib>=0.2.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
```