pcss-qapi 0.1.2__tar.gz → 0.2.0__tar.gz

{pcss_qapi-0.1.2 → pcss_qapi-0.2.0}/.gitlab-ci.yml

@@ -13,14 +13,14 @@ default:
     - apt-get install -y git
     - pip install uv
     - uv venv .venv
-    - uv sync
+    - uv sync --all-extras
     - source .venv/bin/activate
     - uv pip install git+https://ptseries-CI:${PTSERIES_TOKEN}@gitlab.pcss.pl/quantum/ptseries.git
 
 pylint_and_pytest:
   stage: testing and code analysis
   script:
-    - pylint pcss_qapi
+    - ruff check pcss_qapi
     - pytest -v tests
 
   rules:

pcss_qapi-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+    - repo: https://github.com/hhatto/autopep8
+      rev: v2.3.2
+      hooks:
+          - id: autopep8
+            args: ["--max-line-length=140", "--in-place", "--aggressive", "--aggressive"]
+
+    # - repo: local
+    #   hooks:
+    #       - id: pylint
+    #         exclude: ^(tests|docs)/.*$
+    #         name: pylint
+    #         entry: .venv/bin/pylint
+    #         language: system
+    #         types: [python]
+    #         args: ["-rn", "-sn", "--rcfile=pylintrc"]
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.15.6
+      hooks:
+          - id: ruff-check
+          - id: ruff-format

{pcss_qapi-0.1.2 → pcss_qapi-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pcss_qapi
-Version: 0.1.2
+Version: 0.2.0
 Summary: Python client for pcss quantum api
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -11,6 +11,8 @@ Provides-Extra: orca
 Requires-Dist: torch>=2.7.0; extra == "orca"
 Requires-Dist: torchaudio>=2.7.0; extra == "orca"
 Requires-Dist: torchvision>=0.22.0; extra == "orca"
+Provides-Extra: aqt
+Requires-Dist: qiskit-aqt-provider>=1.10.0; extra == "aqt"
 
 # pcss-python-api
 

{pcss_qapi-0.1.2 → pcss_qapi-0.2.0}/docs/_static/css/custom.css

@@ -23,9 +23,11 @@ button.sidebar-toggle {
     max-height: 300px !important;
     max-width: 300px !important;
 
-    height: 100%;
-    width: 100%;
+    height: auto;
+    width: 70%;
 
     min-height: 100px !important;
     min-width: 100px !important;
+
+    margin-bottom: 2rem;
 }

pcss_qapi-0.2.0/docs/_static/logo.svg

@@ -0,0 +1,7 @@
+<svg width="28" height="28" viewBox="0 0 28 28" fill="none" xmlns="http://www.w3.org/2000/svg">
+<mask id="circleMask">
+<rect width="100%" height="100%" fill="white"/>
+<circle cx="14" cy="14" r="4" fill="black"/>
+</mask>
+<path d="M28 14C28 17.427 28 23 28 28C23.5 28 18.305 28 14 28C6.26801 28 -4.74968e-07 21.732 -3.0598e-07 14C-1.36992e-07 6.26801 6.26801 1.36992e-07 14 3.0598e-07C21.732 4.74968e-07 28 6.26801 28 14Z" fill="#005AF7" mask="url(#circleMask)"/>
+</svg>

{pcss_qapi-0.1.2 → pcss_qapi-0.2.0}/docs/conf.py

@@ -4,31 +4,33 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 
-import os
+from pathlib import Path
 import sys
 import tomllib
 from unittest import mock
 import better_apidoc
 
-conf_path = os.path.dirname(os.path.abspath(__file__))
-project_path = os.path.dirname(conf_path)
-lib_path = os.path.join(project_path, 'pcss_qapi')
-sys.path.insert(0, project_path)
+conf_path = Path(__file__).absolute().parent
+project_path = conf_path.parent
+lib_path = project_path / "pcss_qapi"
+sys.path.insert(0, str(project_path))
 
 
 def run_apidoc(app):
     """Generate API documentation"""
     better_apidoc.APP = app
-    better_apidoc.main([
-        'better-apidoc',
-        '-t',
-        os.path.join('.', '_templates'),
-        '--force',
-        '--separate',
-        '-o',
-        os.path.join('.', 'API'),
-        lib_path,  # Generate docs only for qailab/
-    ])
+    better_apidoc.main(
+        [
+            "better-apidoc",
+            "-t",
+            str(Path(".", "_templates")),
+            "--force",
+            "--separate",
+            "-o",
+            str(Path(".", "API")),
+            str(lib_path),  # Generate docs only for qailab/
+        ]
+    )
 
 
 # -- Project information -----------------------------------------------------
@@ -36,33 +38,33 @@ def run_apidoc(app):
 
 # Grab info from pyproject.toml
 
-with open(os.path.join(project_path, 'pyproject.toml'), 'rb') as f:
+with open(project_path / "pyproject.toml", "rb") as f:
     parsed_pyproject = tomllib.load(f)
 
-name = parsed_pyproject['project']['name'].replace('_', ' ').title()
-version = parsed_pyproject['project']['version']
+name = parsed_pyproject["project"]["name"].replace("_", " ").title()
+version = parsed_pyproject["project"]["version"]
 
 project = name
-copyright = '2025, psnc-qcg'
-author = 'pcss'
+copyright = "2025, psnc-qcg"
+author = "pcss"
 release = version
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 suppress_warnings = [
-    'myst.header',  # ipynb linter
-    'myst.xref_missing',
-    'docutils'  # rst linter
+    "myst.header",  # ipynb linter
+    "myst.xref_missing",
+    "docutils",  # rst linter
 ]
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.viewcode',
-    'sphinx_copybutton',
-    'myst_nb',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.viewcode",
+    "sphinx_copybutton",
+    "myst_nb",
 ]
 
 myst_enable_extensions = [
@@ -78,7 +80,7 @@ viewcode_line_numbers = True
 autodoc_typehints = "both"
 autodoc_typehints_description_target = "documented"
 
-autodoc_mock_imports = ['sklearn']
+autodoc_mock_imports = ["sklearn"]
 
 for module in autodoc_mock_imports:
     sys.modules[module] = mock.MagicMock()
@@ -87,30 +89,23 @@ napoleon_numpy_docstring = False
 
 nb_execution_mode = "off"
 
-templates_path = ['_templates']
-exclude_patterns = [
-    '_build',
-    'Thumbs.db',
-    '.DS_Store',
-    'tests/*',
-    '*.md',
-    'API/modules.rst'
-]
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "tests/*", "*.md", "API/modules.rst"]
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_static_path = ['_static']
-html_css_files = ['css/custom.css']
+html_static_path = ["_static"]
+html_css_files = ["css/custom.css"]
 
-html_theme = 'sphinx_book_theme'
-html_logo = '_static/logo.svg'
+html_theme = "sphinx_book_theme"
+html_logo = "_static/logo.svg"
 html_favicon = "_static/logo.svg"
 
 html_show_sourcelink = False  # Disable option to show .rst source
 
 
 def setup(app):
-    app.connect('builder-inited', run_apidoc)
-    app.add_css_file('css/custom.css')
+    app.connect("builder-inited", run_apidoc)
+    app.add_css_file("css/custom.css")

pcss_qapi-0.2.0/docs/examples.rst

@@ -0,0 +1,55 @@
+Examples
+========
+
+Getting a backend
+------------------
+::
+    
+    from pcss_qapi import AuthorizationService
+    from pcss_qapi.orca import OrcaProvider
+
+    AuthorizationService.login()
+
+    provider = OrcaProvider()
+
+    backend = provider.least_busy()
+
+TBI sampling
+------------------
+
+::
+
+    backend: OrcaBackend = ...
+
+    tbi = backend.get_tbi()
+
+    samples = tbi.sample(input_state=[1, 0], theta_list=[np.pi/4], n_samples=10)
+
+
+PTLayer inference
+------------------
+
+::
+
+    import torch
+    
+    backend: OrcaBackend = ...
+
+    ptlayer = backend.get_ptlayer(in_features=2)
+    output = ptlayer(torch.tensor([[1.0,-1.0]],dtype=torch.float32))
+
+Binary Bosonic Solver training
+------------------
+
+::
+
+    backend: OrcaBackend = ...
+
+    objective = lambda sample_array: -sample_array[0] #"optimize" for the first qumode to be a 1
+
+    bbs = backend.get_bbs(pb_dim = 4, objective = objective_function)
+    
+    bbs.solve(updates=20, print_frequency=2)
+
+    best_energy = bbs.best_cost
+    solution = bbs.best_solution

{pcss_qapi-0.1.2 → pcss_qapi-0.2.0}/docs/index.rst

@@ -15,7 +15,7 @@ Getting started
 You can install PCSS-QAPI via pip:
 ::
 
-   pip install TBD
+   pip install pcss-qapi
 
 
 Then you can get to know the library by checking out the following sections:

{pcss_qapi-0.1.2 → pcss_qapi-0.2.0}/docs/tutorials.rst

@@ -10,4 +10,4 @@ Usage
 .. toctree::
    :maxdepth: 1
 
-   tutorials/orca
+   tutorials/orca_pt1

pcss_qapi-0.2.0/examples/orca_dependencyless.ipynb

@@ -0,0 +1,173 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "994dd930",
+   "metadata": {},
+   "source": [
+    "# Using PCSS QAPI for ORCA-PT-1 "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "8d992eb8",
+   "metadata": {},
+   "source": [
+    "## Logging in"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "03500607",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pcss_qapi import AuthorizationService\n",
+    "\n",
+    "AuthorizationService.login()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "925d57fa",
+   "metadata": {},
+   "source": [
+    "## Getting a provider"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "cf329b19",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pcss_qapi.orca import OrcaProvider\n",
+    "\n",
+    "provider = OrcaProvider()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "6e22bc02",
+   "metadata": {},
+   "source": [
+    "## Getting a backend\n",
+    "\n",
+    "A list of available backends can be fetched from the provider."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a5ec92d4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "provider.available_backends(simulators=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "dcc9557a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "provider.available_backends(simulators=False)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b325f14d",
+   "metadata": {},
+   "source": [
+    "A backend can either be specified by name or automatically fetched based on the smallest queue length (real devices only)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a146e08d",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "backend = provider.get_backend(\"single_loop_simulator\")\n",
+    "backend"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5bcf00c7",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "backend = provider.least_busy()\n",
+    "backend"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "42fc4a13",
+   "metadata": {},
+   "source": [
+    "## Using the ORCA-PT-1 quantum computer\n",
+    "\n",
+    "Each backend represents a single quantum computer (or simulator) and provides a few options of interacting with the device:\n",
+    "- A simple TBI (Time Bin Inferometer) class for sampling\n",
+    "- A PyTorch compatible layer for integrating the PT-1 into neural networks\n",
+    "- A Binary Bosonic Solver class for solving combinatorial optimization problems"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "f1e9c4c6",
+   "metadata": {},
+   "source": [
+    "### TBI"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "712583f2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "tbi = backend.get_tbi(n_loops=1, loop_lengths=[1])\n",
+    "tbi.sample(input_state=[0, 1, 0], theta_list=[1, 2], n_samples=200, n_tiling=1)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "117dbb9e",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "pcss-qapi (3.11.11)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.11"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}