qciconnect 0.3.0__tar.gz

qciconnect-0.3.0/CHANGELOG.md

@@ -0,0 +1,76 @@
+## 0.3.0 (2025-05-15)
+
+### changed (3 changes)
+
+- [Release 0.3.0](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/commit/4e308048e2f2c61fb454c85c6feeeb6cda7f7199) ([merge request](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/merge_requests/68))
+- [Rename hequate -> qciconnect](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/commit/7bc555074613d9b5c7bf12a1293972fe83e11ee9) ([merge request](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/merge_requests/62))
+- [Return a "future" instead of the job id when submitting jobs non-blocking.](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/commit/00f473ec6d411143a1cd57e2df48c8f4edc88b1e) ([merge request](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/merge_requests/51))
+
+### fixed (3 changes)
+
+- [Fixed missing dependencies and versioning in ci pipeline](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/commit/c226ffaf47ad559913d6e3117520740fd7ce5c72) ([merge request](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/merge_requests/67))
+- [Fixed version numbers](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/commit/2f9a70996dc1fdee06e8ae524fb6104b4cae316c) ([merge request](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/merge_requests/58))
+- [Fixed auto-completion in jupyter notebooks for nested classes](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/commit/e506830adea614c3a95d0dcb5ccf4d7980b60f80) ([merge request](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/merge_requests/66))
+
+### added (3 changes)
+
+- [Added further code for error handling when accessing qpus.](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/commit/9aee40ae48c2ca49b4a80e36cbb714921f968451) ([merge request](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/merge_requests/61))
+- [Added handling of errors that can occur during initialization of QciConnectClient.](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/commit/7ec3ac526ec7b9c278e0631021c15f5ef962b921) ([merge request](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/merge_requests/63))
+- [Added Further e2e tests (against the platform)](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/commit/41b052932b4b46a7402d2a81574976d0fa3aab22)
+
+### improved (1 change)
+
+- [Improved error handling so that more meaningful messages are shown to the user](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/commit/b90b19a0c57591cc0caf47c12350ff7f3803d627) ([merge request](https://gitlab.dlr.de/qci-connect/partners/all/qciconnect-sdk/-/merge_requests/65))
+
+## 0.2.0 (2025-04-01)
+
+### added (12 changes)
+
+- [Keycloak support implemented](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/e1ef46b0a5b2783752449abff6dff5ce33e030ec) ([merge request](https://gitlab.dlr.de/qc/compilation/hequate/-/merge_requests/45))
+- [Added "example_remote.ipynb" to test suite so that functionality of the...](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/29d03b29b0e1c6037174d0474228296e5c55980f) ([merge request](https://gitlab.dlr.de/qc/compilation/hequate/-/merge_requests/44))
+- [Added release automation](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/b1d7935a6e892e584cc2f33f9827174b690365fa)
+- [Added changelog-creation automation](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/de48315a9aeb4bd5d171fbd62ece1848d2736b12) ([merge request](https://gitlab.dlr.de/qc/compilation/hequate/-/merge_requests/38))
+- [Added test coverage calculation to the ci](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/7bb7c791)
+- [Implemented Non-blocking calls](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/37368a3a)
+- [Added unit tests for qpu communication](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/98fabd66)
+- [CI: Added build stage. Use this built for the testing](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/755bf1ab)
+- [CI: Added unit tests for hequate client](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/134b1dfd)
+- [CI: Re-enabled end to end tests](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/854d6bb8)
+- [CI: Added end-to-end client tests](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/6e617974)
+- [Added pydantic magic to validate and dump json](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/539f81b2)
+
+### changed (5 changes)
+
+- [Improved release process](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/c7bfe1f33bbd649154f5fa4cb5e95c7703308a0d) ([merge request](https://gitlab.dlr.de/qc/compilation/hequate/-/merge_requests/40))
+- [Update README.md and minor fixes](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/4ef9d20d5c69b7e74a4c47eef80290c20bd75482) ([merge request](https://gitlab.dlr.de/qc/compilation/hequate/-/merge_requests/30))
+- [Aligned compiler integration with the QCi connect platform](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/d5f64a4225ae1e88962b56e86ad36e0137102a2d) ([merge request](https://gitlab.dlr.de/qc/compilation/hequate/-/merge_requests/35))
+- [Update QSP compiler image](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/a9b179a8d1ab12eb06a653491790804388ed963b) ([merge request](https://gitlab.dlr.de/qc/compilation/hequate/-/merge_requests/36))
+- [Replaced manual rendering of QPU.show() by tabulate lib. Made parameters...](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/94bd834f82d690f74b3799bc3a1932f54ddfc2d0) ([merge request](https://gitlab.dlr.de/qc/compilation/hequate/-/merge_requests/33))
+
+### fixed (7 change)
+
+- [Check for succesful connection during instantiation](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/214ed08cc19fe676c776cd44fd53c5b4fd295986) ([merge request](https://gitlab.dlr.de/qc/compilation/hequate/-/merge_requests/43))
+- [Increased timeout for blocking interaction with QCI Connect](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/d7d04607)
+- [Enabled use of mini-orchestrator while in VPN](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/3275303d)
+- [Added pyproject.toml for packaging of hequate lib/client](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/e440388d)
+- [Resolved "Improve auto-completion](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/fcbc4f3f)
+- [Removed deprecated files](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/c1fd7877)
+- [Fixed #251: document client side source code](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/93b65a8c)
+
+
+## 0.1.0 (2025-01-21)
+
+### added (7 changes)
+
+- [Added a proof of concept for compiler container/image handling of the mini orchestrator](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/dd7d2a6c71ddf657bc96eb48cea009dd133eca0d)
+- [Added basic client side QPU handling](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/49f84a6963116545344c49c50e2ea95b49ed2c7a)
+- [Added usage examples, see hequate/examples folder](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/25cda8cf1372904fd9d108c85ca67b3c0c01f4e4)
+- [Added a first compiler pass](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/99511c3ff3c175b3e58112078a5aa7e1d6f71b51)
+- [Added API client capabilities](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/32a30b1fdc6709cb8373af659cab08888ccdc88a)
+- [Added an orchestrator](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/b75d51ab2b8e7787458d3e820b676afbdcf11fbd)
+- [Added a docker compose setup](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/b240681c2ae1258152aee15ea0210973acca0315)
+
+### changed (2 changes)
+
+- [Updated the orchestrator](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/54f8d04f7f5f9f7d9b1bee5189777c6589ba27e5)
+- [Updated docker compose setup](https://gitlab.dlr.de/qc/compilation/hequate/-/commit/adf91059870dd46f20564dbc2891717950dee2c4)

qciconnect-0.3.0/CONTRIBUTORS

@@ -0,0 +1,5 @@
+Johannes Renkl
+David Emmanuel-Costa
+Thomas Keitzl
+Thomas Stehle
+Monika Das

qciconnect-0.3.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 German Aerospace Center / Deutsches Zentrum für Luft- und Raumfahrt (DLR)
+
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

qciconnect-0.3.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.3
+Name: qciconnect
+Version: 0.3.0
+Summary: An API client to work with the DLR QCI Connect quantum computing platform.
+License: MIT
+Keywords: quantum computing,API client,QCI Connect
+Author: DLR-SC
+Author-email: qc-software@dlr.de
+Requires-Python: >=3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python
+Classifier: Operating System :: OS Independent
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: numpy (>=1.26.0,<2.0.0)
+Requires-Dist: pydantic (>=2.10.6,<3.0.0)
+Requires-Dist: python-keycloak (>=5.3.1,<6.0.0)
+Requires-Dist: tabulate (>=0.9.0,<0.10.0)
+Description-Content-Type: text/markdown
+
+# QCI Connect SDK
+
+This is a python package to interact with the [QCi Connect](http://qc-plat-pro.dlr.de/) platform of the [German Aerospace Center (DLR)](https://www.dlr.de/). 
+It also allows to login to the platform, obtain a session token, submit quantum circuits for compilation and execution, and retrieve the results of the execution. 
+
+## Quick start
+
+The following steps provide a quick start on how to programmatically interact with the QCi Connect platform:
+
+- Run `pip install qciconnect`
+- Run `jupyter notebook` and navigate to _./examples/example_remote.ipynb_
+
+

qciconnect-0.3.0/README.md

@@ -0,0 +1,12 @@
+# QCI Connect SDK
+
+This is a python package to interact with the [QCi Connect](http://qc-plat-pro.dlr.de/) platform of the [German Aerospace Center (DLR)](https://www.dlr.de/). 
+It also allows to login to the platform, obtain a session token, submit quantum circuits for compilation and execution, and retrieve the results of the execution. 
+
+## Quick start
+
+The following steps provide a quick start on how to programmatically interact with the QCi Connect platform:
+
+- Run `pip install qciconnect`
+- Run `jupyter notebook` and navigate to _./examples/example_remote.ipynb_
+

qciconnect-0.3.0/commons/hequate_common/__init__.py

@@ -0,0 +1 @@
+"""Init file for hequate_common module."""

qciconnect-0.3.0/commons/hequate_common/models.py

@@ -0,0 +1,158 @@
+# generated by fastapi-codegen:
+#   filename:  ./api-wrapper/openapi.yaml
+#   timestamp: 2025-01-08T11:10:30+00:00
+
+from __future__ import annotations
+
+from datetime import datetime
+from enum import Enum
+from typing import Any, Dict, List, Optional, Union
+from uuid import UUID
+
+from pydantic import BaseModel, Extra, Field, PositiveFloat, PositiveInt, conint, constr
+
+class CompilerStatus(Enum):
+    running = 'running'
+    offline = 'offline'
+    maintenance = 'maintenance'
+
+
+class CompilerTable(BaseModel):
+    name: str = Field(..., title='Name')
+    manufacturer: Optional[str] = Field(..., title='Manufacturer')
+    status: CompilerStatus
+    description: Optional[constr(min_length=0, max_length=512)] = Field(
+        ..., title='Description'
+    )
+    time_limit: PositiveFloat = Field(..., title='Time Limit')
+    passes_available: Optional[Dict[str, bool]] = Field(None, title='Passes Available')
+    compiler_id: int = Field(..., title='Compiler Id')
+#    compiler_alias: str = Field(..., title='Compiler Alias')
+
+class CompilerTaskBase(BaseModel):
+    compiler_id: Optional[int] = Field(..., title='Compiler Id')
+    compilation_pass: str
+    options: Optional[Dict[str, Any]] = Field(None, title='Options')
+
+
+class CompilerTaskResult(BaseModel):
+    meta_data: Any = Field(..., title='Meta Data')
+    status: str = Field(..., title='Status')
+    status_message: Optional[str] = Field(..., title='Status Message')
+    start_date_time: Optional[str] = Field(..., title='Start Date Time')
+    end_date_time: Optional[str] = Field(..., title='End Date Time')
+    total_runtime: Optional[float] = Field(..., title='Total Runtime')
+    compiled_circuit: Optional[Union[str,List[str]]] = Field(..., title='Compiled Circuit')
+
+
+class Primitive(Enum):
+    sampling = 'sampling'
+    quantum_state = 'quantum_state'
+
+
+class QPUOptions(BaseModel):
+    class Config:
+        extra = Extra.forbid
+
+    coupling_map: Optional[List[List[conint(ge=0)]]] = Field(None, title='Coupling Map')
+    basis_gates: Optional[List[str]] = Field(None, title='Basis Gates')
+
+
+class QPUStatus(Enum):
+    idle = 'idle'
+    running = 'running'
+    offline = 'offline'
+    maintenance = 'maintenance'
+
+
+class QPUTaskBase(BaseModel):
+    total_shots: Optional[conint(ge=1, le=1000000)] = Field(1, title='Total Shots')
+    qpu_id: int = Field(..., title='Qpu Id')
+    primitive: Optional[Primitive] = 'sampling'
+    qpu_options: Optional[QPUOptions]
+    class Config:  
+        use_enum_values = True
+
+
+class QPUTaskResult(BaseModel):
+    meta_data: Any = Field(..., title='Meta Data')
+    status: str = Field(..., title='Status')
+    status_message: Optional[str] = Field(..., title='Status Message')
+    start_date_time: Optional[str] = Field(..., title='Start Date Time')
+    end_date_time: Optional[str] = Field(..., title='End Date Time')
+    total_runtime: Optional[float] = Field(..., title='Total Runtime')
+    data: Optional[str] = Field(..., title='Data')
+
+
+class Technology(Enum):
+    statevector_simulator = 'statevector_simulator'
+    trapped_ions = 'trapped_ions'
+    neutral_atoms = 'neutral_atoms'
+    vacancy_centers = 'vacancy_centers'
+
+
+class ValidationError(BaseModel):
+    loc: List[Union[str, int]] = Field(..., title='Location')
+    msg: str = Field(..., title='Message')
+    type: str = Field(..., title='Error Type')
+
+
+class HTTPValidationError(BaseModel):
+    detail: Optional[List[ValidationError]] = Field(None, title='Detail')
+
+
+class JobInfo(BaseModel):
+    circuit: str = Field(..., title='Circuit')
+    primitive: Optional[Primitive] = 'sampling'
+    name: constr(min_length=1, max_length=64) = Field(..., title='Name')
+    comment: Optional[constr(min_length=0, max_length=512)] = Field(
+        ..., title='Comment'
+    )
+    job_id: UUID = Field(..., title='Job Id')
+    submission_date_time: datetime = Field(..., title='Submission Date Time')
+    status: str = Field(..., title='Status')
+    status_message: Optional[str] = Field(..., title='Status Message')
+    qpu_name: str = Field(..., title='Qpu Name')
+    last_compiler_task: Optional[CompilerTaskBase]
+    last_qpu_task: Optional[QPUTaskBase]
+
+
+class JobResult(BaseModel):
+    status: str = Field(..., title='Status')
+    status_message: Optional[str] = Field(..., title='Status Message')
+    start_date_time: Optional[str] = Field(..., title='Start Date Time')
+    end_date_time: Optional[str] = Field(..., title='End Date Time')
+    total_runtime: Optional[float] = Field(..., title='Total Runtime')
+    last_compiler_result: Optional[CompilerTaskResult]
+    last_qpu_result: Optional[QPUTaskResult]
+
+
+class JobSubmission(BaseModel):
+    circuit: str = Field(..., title='Circuit')
+    primitive: Optional[Primitive] = 'sampling'
+    name: constr(min_length=1, max_length=64) = Field(..., title='Name')
+    comment: Optional[constr(min_length=0, max_length=512)] = Field(
+        ..., title='Comment'
+    )
+    tasks: List[Union[CompilerTaskBase, QPUTaskBase]] = Field(..., title='Tasks')
+    class Config:  
+        use_enum_values = True
+
+
+class QPUTable(BaseModel):
+    manufacturer: str = Field(..., title='Manufacturer')
+    name: str = Field(..., title='Name')
+    technology: Technology
+    status: QPUStatus
+    number_of_qubits_available: PositiveInt = Field(
+        ..., title='Number Of Qubits Available'
+    )
+    circuit_depth_limit: conint(ge=0) = Field(..., title='Circuit Depth Limit')
+    shot_limit: PositiveInt = Field(..., title='Shot Limit')
+    description: Optional[constr(min_length=0, max_length=512)] = Field(
+        ..., title='Description'
+    )
+    time_limit: PositiveFloat = Field(..., title='Time Limit')
+    measurement_required: Optional[bool] = Field(..., title='Measurement Required')
+    qpu_id: int = Field(..., title='Qpu Id')
+    qpu_alias: str = Field(..., title='Qpu Alias')

qciconnect-0.3.0/commons/hequate_common/poetry.lock

@@ -0,0 +1,7 @@
+# This file is automatically @generated by Poetry 2.1.1 and should not be changed by hand.
+package = []
+
+[metadata]
+lock-version = "2.1"
+python-versions = "3.12.7"
+content-hash = "f9cb939844ead6cfd2e67f7db8a63ce7d1dc35fb730021a24f897d86edd93ff9"

qciconnect-0.3.0/commons/hequate_common/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "hequate_common"
+version = "0.1.0"
+
+[tool.poetry]
+name = "hequate_common"
+version = "0.1.0"
+description = ""
+authors = ["Hequate Software Team"]
+packages = [
+   {include = "hequate_common", from = ".."}
+]
+
+[tool.poetry.dependencies]
+python = "3.12.7"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

qciconnect-0.3.0/commons/qciconnect_common/.dockerignore

@@ -0,0 +1,9 @@
+**__pycache__
+**/tests/
+**.pytest_cache
+**.ruff_cache
+.venv
+**README.md 
+.gitignore
+**.code-workspace
+

qciconnect-0.3.0/commons/qciconnect_common/.gitignore

@@ -0,0 +1,129 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don’t work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+**/__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# profiling data
+.prof

qciconnect-0.3.0/commons/qciconnect_common/README.md

@@ -0,0 +1,28 @@
+# qciconnect_common
+
+The qciconnect_common component contains packages or modules that can be shared and reused across all other components. The component is seperated into different sub-components based on their related technical background or functionality. The component can be included in other services by including
+
+    [tool.poetry.dependencies]
+    ...
+    qciconnect_common = {path = "../commons/qciconnect_common/"}
+    ...
+
+in the respective pyproject.toml file. Don't forget to include the relevant packages also in your Dockerfiles (see Orchestrator Dockerfile).
+
+Please be aware that the command `poetry install` is not necessary for this module, as there is no need to set up an independent Python environment and the component isn't designed to operate autonomously. The existing pyproject.toml file merely provides essential information about the module, and its purpose is to facilitate the module's integration into other services.
+
+## qciconnect_logging
+
+Within this qciconnect_common package, a logger is setup for universal application across all components of the platform. This logger is imbued with an array of formatting options specifically designed to streamline the debugging process. It allows users to seamlessly import and apply it to their individual services or modules, thereby ensuring uniformly formatted and consistent logging information across the complete platform. At this stage, log outputs are solely directed to the console. However, it is our future intention to accumulate these logs, particularly within a production environment setting.
+
+## qciconnect_scheduler
+
+Contains a celery app factory with default connection strings. To be used by all other services that require a Celery instance.
+
+## qciconnect_settings
+
+Holds environmental variable settings. Env variables defined in a .env file will  automatically populate in a corresponding Python class `EnvironmentSettings`. The `get_settings` method can be used to access the variables in different services.
+
+## qciconnect_conversion
+
+Provides various helper classes with methods for conversion between data formats, for which no onboard tools exist, e.g., between JSON compatible strings and complex numbers, Numpy arrays, datetime, etc.

qciconnect-0.3.0/commons/qciconnect_common/__init__.py

@@ -0,0 +1 @@
+"""Init file for qciconnect_common module."""