qciconnect-miniserver 0.3.0

Mini server for local development

QCI Connect Miniserver

This is a python package to locally execute the compilers and simulators of the DLR's QCI Connect platform. It also allows (a) to locally develop algorithms with the goal to integrate them to the platform, (b) to prototype quickly, and (c) to run algorithms on the local computer using the same interface as with QCI Connect API Client.

Checkout Workspace

Once the workspace is cloned, the full functionality of the local compiler base can be initialised as:

git submodule update --init

Quick start for develop mode

The following steps provide a quick start guide for programmatically interacting with the local development environment.

First, verify that Docker (including the Docker Compose plugin) is installed, then build the compiler step images as follows:

cd deployment/docker-dev
cat <token-file> | docker login -u <USER> --password-stdin registry.hzdr.de
docker compose build --no-cache

Next, you’re ready to start the miniserver:

uv sync
source .venv/bin/activate
miniserver

To build the wheel and/or the source distribution (tar.gz), run:

uv build

Troubleshooting

Miniserver

In case you need to restart the miniserver just stop it through CTR+C or

miniserver stop

It could be that miniserver does not restart properly due to compiler-containers still running from previous sections

docker rm -v -f <compiler-container-list>