pcss-qapi 0.1.0__tar.gz

pcss_qapi-0.1.0/.gitignore

@@ -0,0 +1,4 @@
+*.egg-info*
+*__pycache__*
+build
+*.coverage

pcss_qapi-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,51 @@
+image: python:3.12-slim
+
+stages:
+  - testing and code analysis
+  - deploy
+#  - publish
+
+default:
+  before_script:
+    - python --version ; pip --version
+    - apt-get update
+    - apt-get upgrade -y
+    - apt-get install -y git
+    - pip install uv
+    - uv venv .venv
+    - uv sync
+    - source .venv/bin/activate
+
+pylint_and_pytest:
+  stage: testing and code analysis
+  script:
+    - pylint pcss_qapi
+    - pytest -v tests
+
+  rules:
+#    - if: '$CI_COMMIT_BRANCH == "dev" && $CI_PIPELINE_SOURCE == "push"'
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "dev"'
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "main"'
+
+pages:
+  stage: deploy
+  script:
+    - cd docs
+    - mkdir -p tutorials
+    - cp ./../examples/*.ipynb ./tutorials
+    - sphinx-build -b html . ../public
+    - cd ..
+  artifacts:
+    paths:
+      - public
+  rules:
+    - if: '$CI_COMMIT_BRANCH == "main"'
+
+#publish:
+#  stage: publish
+#  script:
+#    - uv pip install build twine
+#    - python -m build
+#    - twine upload dist/* -u "$PyPI_USERNAME" -p "$PyPI_PASSWORD"
+#  rules:
+#    - if: '$CI_COMMIT_BRANCH == "main"'

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

@@ -0,0 +1,16 @@
+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"]

pcss_qapi-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

pcss_qapi-0.1.0/.vscode/.gitignore

@@ -0,0 +1 @@
+launch.json

pcss_qapi-0.1.0/.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "cSpell.words": [
+        "pcss",
+        "ptseries",
+        "qapi",
+        "spsa"
+    ]
+}

pcss_qapi-0.1.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: pcss_qapi
+Version: 0.1.0
+Summary: Python client for pcss quantum api
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: numpy==1.26.4
+Requires-Dist: pyjwt>=2.10.1
+Requires-Dist: requests>=2.32.3
+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"
+
+# pcss-python-api
+
+Python interface for interacting with the pccs-api for accessing quantum computing resources.
+
+Supported computers:
+    - ORCA Computing PT-1
+    

pcss_qapi-0.1.0/README.md

@@ -0,0 +1,7 @@
+# pcss-python-api
+
+Python interface for interacting with the pccs-api for accessing quantum computing resources.
+
+Supported computers:
+    - ORCA Computing PT-1
+    

pcss_qapi-0.1.0/docs/.gitignore

@@ -0,0 +1,3 @@
+API/*
+_build/*
+tutorials/*

pcss_qapi-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pcss_qapi-0.1.0/docs/README.md

@@ -0,0 +1,31 @@
+
+# Docs
+
+## View documentation
+
+```sh
+docs/serve.sh
+```
+
+will serve the documentation files on [localhost:8080](http://localhost:8080). It will also build the documentation automatically if no html files are found (you will need to manually rebuild on changes).
+
+## Build
+
+```sh
+docs/build.sh
+```
+
+will build the documentation.
+
+## Requirements
+
+Requirements needed to build the docs are available in `requirements-dev.txt`, install them with `pip install -r requirements.txt`
+
+**PSA**: The `pandoc` library in python is only a wrapper for the program. You need to manually install the program on your computer:
+
+- Linux: `sudo apt-get install pandoc`
+- Mac: `brew install pandoc`
+- Windows:
+  - `choco install pandoc`
+  - `winget install --source winget --exact --id JohnMacFarlane.Pandoc`
+  - or use a windows installer (have fun :))

pcss_qapi-0.1.0/docs/_static/css/custom.css

@@ -0,0 +1,31 @@
+.bd-page-width {
+    max-width: 100% !important;
+}
+
+button.sidebar-toggle {
+    display: none !important;
+}
+
+.document {
+    width: 100% !important;
+    margin: 50px !important;
+}
+
+.body {
+    max-width: 100% !important;
+}
+
+.bd-sidebar-primary {
+    overflow-y: hidden !important;
+}
+
+.navbar-brand img {
+    max-height: 300px !important;
+    max-width: 300px !important;
+
+    height: 100%;
+    width: 100%;
+
+    min-height: 100px !important;
+    min-width: 100px !important;
+}

pcss_qapi-0.1.0/docs/_static/logo.svg

@@ -0,0 +1,12 @@
+<svg width="64" height="64" viewBox="0 0 64 64" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M44.5 8.5C42.2909 8.5 40.5 10.2909 40.5 12.5V38.5C40.5 40.7091 42.2909 42.5 44.5 42.5H51.5C53.7091 42.5 55.5 40.7091 55.5 38.5V12.5C55.5 10.2909 53.7091 8.5 51.5 8.5H44.5ZM12.5 21.5C10.2909 21.5 8.5 23.2909 8.5 25.5V51.5C8.5 53.7091 10.2909 55.5 12.5 55.5H28.5C30.7091 55.5 32.5 53.7091 32.5 51.5V25.5C32.5 23.2909 30.7091 21.5 28.5 21.5H12.5Z" fill="#1E1E1E"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M44.5 8.5C42.2909 8.5 40.5 10.2909 40.5 12.5V38.5C40.5 40.7091 42.2909 42.5 44.5 42.5H51.5C53.7091 42.5 55.5 40.7091 55.5 38.5V12.5C55.5 10.2909 53.7091 8.5 51.5 8.5H44.5ZM12.5 21.5C10.2909 21.5 8.5 23.2909 8.5 25.5V51.5C8.5 53.7091 10.2909 55.5 12.5 55.5H28.5C30.7091 55.5 32.5 53.7091 32.5 51.5V25.5C32.5 23.2909 30.7091 21.5 28.5 21.5H12.5Z" fill="url(#paint0_linear_340_3781)"/>
+<defs>
+<linearGradient id="paint0_linear_340_3781" x1="50.9995" y1="14.7146" x2="17.4197" y2="52.9332" gradientUnits="userSpaceOnUse">
+<stop stop-color="#005FFE"/>
+<stop offset="0.28047" stop-color="#0159F5"/>
+<stop offset="0.73457" stop-color="#054BDD"/>
+<stop offset="1" stop-color="#0941CC"/>
+</linearGradient>
+</defs>
+</svg>

pcss_qapi-0.1.0/docs/_templates/layour.rst

@@ -0,0 +1,5 @@
+{# layout.html #}
+{# Import the layout of the theme. #}
+{% extends "!layout.html" %}
+
+{% set css_files = css_files + ['_static/css/custom.css'] %}

pcss_qapi-0.1.0/docs/_templates/module.rst

@@ -0,0 +1,75 @@
+{# The :autogenerated: tag is picked up by breadcrumbs.html to suppress "Edit on Github" link #}
+{# This code is from https://github.com/goerz/better-apidoc?tab=readme-ov-file#}
+:autogenerated:
+
+{{ fullname }}
+{% for item in range(7 + fullname|length) -%}={%- endfor %}
+
+.. currentmodule:: {{ fullname }}
+
+.. automodule:: {{ fullname }}
+    {% if members -%}
+    :members: {{ members|join(", ") }}
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource
+
+    Summary
+    -------
+
+    {%- if exceptions %}
+
+    Exceptions:
+
+    .. autosummary::
+        :nosignatures:
+{% for item in exceptions %}
+        {{ item }}
+{%- endfor %}
+    {%- endif %}
+
+    {%- if classes %}
+
+    Classes:
+
+    .. autosummary::
+        :nosignatures:
+{% for item in classes %}
+        {{ item }}
+{%- endfor %}
+    {%- endif %}
+
+    {%- if functions %}
+
+    Functions:
+
+    .. autosummary::
+        :nosignatures:
+{% for item in functions %}
+        {{ item }}
+{%- endfor %}
+    {%- endif %}
+{%- endif %}
+
+{% set data = get_members(typ='data', in_list='__all__') %}
+    {%- if data %}
+
+    Data:
+
+    .. autosummary::
+        :nosignatures:
+{% for item in data %}
+        {{ item }}
+{%- endfor %}
+    {%- endif %}
+
+{% set all_refs = get_members(in_list='__all__', include_imported=True, out_format='refs') %}
+{% if all_refs %}
+    ``__all__``: {{ all_refs|join(", ") }}
+{%- endif %}
+
+
+{% if members %}
+    Reference
+    ---------
+{%- endif %}

pcss_qapi-0.1.0/docs/_templates/package.rst

@@ -0,0 +1,115 @@
+{# The :autogenerated: tag is picked up by breadcrumbs.html to suppress "Edit on Github" link #}
+{# This code is from https://github.com/goerz/better-apidoc?tab=readme-ov-file#}
+:autogenerated:
+
+{{ fullname }}
+{% for item in range(8 + fullname|length) -%}={%- endfor %}
+
+.. automodule:: {{ fullname }}
+    {% if members -%}
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    {%- endif %}
+
+{% if submodules %}
+    Submodules:
+
+    .. toctree::
+       :maxdepth: 1
+{% for item in submodules %}
+       {{ fullname }}.{{ item }}
+       {%- endfor %}
+    {%- endif -%}
+
+{% if subpackages %}
+    Subpackages:
+
+    .. toctree::
+       :maxdepth: 1
+{% for item in subpackages %}
+       {{ fullname }}.{{ item }}
+       {%- endfor %}
+    {%- endif %}
+
+{% set all = get_members(in_list='__all__', include_imported=True) %}
+{% if members or all %}
+    Summary
+    -------
+
+{%- set exceptions = get_members(typ='exception', in_list='__all__', include_imported=True, out_format='table') -%}
+{%- set classes = get_members(typ='class', in_list='__all__', include_imported=True, out_format='table') -%}
+{%- set functions = get_members(typ='function', in_list='__all__', include_imported=True, out_format='table') -%}
+{%- set data = get_members(typ='data', in_list='__all__', include_imported=True, out_format='table') -%}
+{%- set private_exceptions = get_members(typ='exception', in_list='__private__', out_format='table') -%}
+{%- set private_classes = get_members(typ='class', in_list='__private__', out_format='table') -%}
+{%- set private_functions = get_members(typ='function', in_list='__private__', out_format='table') -%}
+
+    {%- if exceptions %}
+
+    ``__all__`` Exceptions:
+
+{% for line in exceptions %}
+    {{ line }}
+{%- endfor %}
+    {%- endif %}
+    {%- if private_exceptions %}
+
+    Private Exceptions:
+
+{% for line in private_exceptions %}
+    {{ line }}
+{%- endfor %}
+    {%- endif %}
+
+    {%- if classes %}
+
+    ``__all__`` Classes:
+
+{% for line in classes %}
+    {{ line }}
+{%- endfor %}
+    {%- endif %}
+    {%- if private_classes %}
+
+    Private Classes:
+
+{% for line in private_classes %}
+    {{ line }}
+{%- endfor %}
+    {%- endif %}
+
+    {%- if functions %}
+
+    ``__all__`` Functions:
+
+{% for line in functions %}
+    {{ line }}
+{%- endfor %}
+    {%- endif %}
+    {%- if private_functions %}
+
+    Private Functions:
+
+{% for line in private_functions %}
+    {{ line }}
+{%- endfor %}
+    {%- endif %}
+
+    {%- if data %}
+
+    ``__all__`` Data:
+
+{% for line in data %}
+    {{ line }}
+{%- endfor %}
+    {%- endif %}
+
+{%- endif %}
+
+
+{% if members %}
+    Reference
+    ---------
+
+{%- endif %}

pcss_qapi-0.1.0/docs/build.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# Builds the documentation 
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+cd $SCRIPT_DIR
+
+mkdir -p tutorials
+cp ./../examples/*.ipynb ./tutorials
+
+make clean
+make html

pcss_qapi-0.1.0/docs/conf.py

@@ -0,0 +1,112 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+
+import os
+import sys
+import tomllib
+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)
+
+
+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/
+    ])
+
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+# Grab info from pyproject.toml
+
+with open(os.path.join(project_path, 'pyproject.toml'), 'rb') as f:
+    parsed_pyproject = tomllib.load(f)
+
+name = parsed_pyproject['project']['name'].replace('_', ' ').title()
+version = parsed_pyproject['project']['version']
+
+project = name
+copyright = '2025, psnc-qcg'
+author = 'psnc-qcg'
+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
+]
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.viewcode',
+    'sphinx_copybutton',
+    'myst_nb',
+]
+
+myst_enable_extensions = [
+    "amsmath",
+    "colon_fence",
+    "deflist",
+    "dollarmath",
+    "html_image",
+]
+
+viewcode_line_numbers = True
+
+autodoc_typehints = "both"
+autodoc_typehints_description_target = "documented"
+
+autodoc_mock_imports = ['sklearn', 'ptseries']
+
+napoleon_numpy_docstring = False
+
+nb_execution_mode = "off"
+
+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_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')

pcss_qapi-0.1.0/docs/examples.rst

@@ -0,0 +1,20 @@
+Examples
+========
+
+PTLayer inference
+------------------
+
+::
+
+    import torch
+
+    from pcss_qapi import AuthorizationService
+    from pcss_qapi.orca import OrcaProvider
+
+    AuthorizationService.login()
+
+    provider = OrcaProvider()
+
+    backend = provider.get_backend("ORCA-PT-1-A")
+    ptlayer = backend.get_ptlayer(in_features=2)
+    output = ptlayer(torch.tensor([[1.0,-1.0]],dtype=torch.float32))

pcss_qapi-0.1.0/docs/index.rst

@@ -0,0 +1,28 @@
+PCSS-QAPI Docs
+=====================
+
+----------------
+About project
+----------------
+PCSS-QAPI is a allowing you to use pcss quantum computers.
+For now it supports:
+   - ORCA Computing PT-1 models
+
+----------------
+Getting started
+----------------
+
+You can install PCSS-QAPI via pip:
+::
+
+   pip install TBD
+
+
+Then you can get to know the library by checking out the following sections:
+
+.. toctree::
+   :maxdepth: 1
+
+   examples
+   tutorials
+   API Documentation <API/pcss_qapi>

pcss_qapi-0.1.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

pcss_qapi-0.1.0/docs/serve.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+#Serves the documentation on localhost:8080
+#Builds if necessary
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+cd $SCRIPT_DIR
+
+#Check if the build directory exists
+if [ ! -d "_build" ]; then
+    ./build.sh
+fi
+
+cd _build/html
+
+echo "Docs available at http://localhost:8080"
+python3 -m http.server -b 127.0.0.1 8080 > /dev/null 2>&1 

pcss_qapi-0.1.0/docs/tutorials.rst

@@ -0,0 +1,13 @@
+Tutorials
+============
+
+This section contains several tutorials, that will help you to get started with PCSS-QAPI.
+
+------
+Usage
+------
+
+.. toctree::
+   :maxdepth: 1
+
+   tutorials/orca