qciconnect 0.3.0__py3-none-any.whl

commons/hequate_common/__init__.py

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

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')

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"

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"

commons/qciconnect_common/.dockerignore

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

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

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.

commons/qciconnect_common/__init__.py

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