qc-parallelizer 1.0.0__tar.gz

qc_parallelizer-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Upload package to PyPI
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install build
+        run: python3 -m pip install build --user
+      - name: Build package
+        run: python3 -m build
+      - name: Store distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: ./dist
+  publish-to-pypi:
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+    needs:
+      - build
+    environment:
+      name: pypi
+      url: https://pypi.org/p/qc-parallelizer
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: ./dist
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+    

qc_parallelizer-1.0.0/.gitignore

@@ -0,0 +1,174 @@
+# 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/
+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/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

qc_parallelizer-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+  - id: check-yaml
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+  - id: check-executables-have-shebangs
+  - id: debug-statements
+  - id: mixed-line-ending
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.5.2
+  hooks:
+  - id: ruff
+    args: [ --fix ]
+    types_or: [ python, pyi, jupyter ]
+  - id: ruff-format
+    types_or: [ python, pyi, jupyter ]
+
+- repo: https://github.com/asottile/add-trailing-comma
+  rev: v3.1.0
+  hooks:
+  - id: add-trailing-comma
+
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.16.0
+  hooks:
+  - id: pyupgrade
+    args: [ --py310-plus ]
+
+- repo: https://github.com/kynan/nbstripout
+  rev: 0.7.1
+  hooks:
+  - id: nbstripout

qc_parallelizer-1.0.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: qc-parallelizer
+Version: 1.0.0
+Summary: A module for optimally combining and distributing quantum circuits
+Author-email: Henri Ahola <henri.ahola@vtt.fi>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: qiskit==0.45.3
+Provides-Extra: tests
+Requires-Dist: qiskit-iqm==13.7; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Provides-Extra: notebooks
+Requires-Dist: qiskit-iqm==13.7; extra == "notebooks"
+Requires-Dist: ipykernel; extra == "notebooks"
+Requires-Dist: matplotlib; extra == "notebooks"
+Requires-Dist: pylatexenc; extra == "notebooks"
+
+# Quantum Circuit Parallelizer
+
+A Python module for optimally combining and distributing quantum circuits. See the
+[included notebooks](./notebooks/) for examples and more information. In summary, the motivation
+for this module comes from frequent underutilization of increasingly large quantum processors. The
+module processes several independent circuits into a smaller set of wider, combined circuits, which
+it then runs on available backends in parallel. All of this happens behind the scenes, so ideally
+the user can treat the module's functionality as a parallelized drop-in replacement for Qiskit's
+`backend.run()`.
+
+Here is a brief and basic example:
+
+```python
+# Define or load a number of circuits.
+from qiskit import QuantumCircuit
+circuits = [QuantumCircuit(...), QuantumCircuit(...), ...]
+
+# Define backends for circuit execution. These can be any Qiskit-compatible backend objects, but
+# here we define two simulators that mimic IQM's 5-qubit Adonis architechture.
+import iqm.qiskit_iqm as iqm
+backends = [iqm.IQMFakeAdonis(), iqm.IQMFakeAdonis()]
+
+# Parallelize and execute. This call will
+#  1. determine how to combine the circuits and for which backends, and
+#  2. submit jobs to the backends.
+import qc_parallelizer as parallelizer
+job = parallelizer.execute(circuits, backends=backends)
+
+# Fetch and handle results. This plots the first circuit's result histogram, for example.
+results = job.results()
+qiskit.visualization.plot_histogram(result[0].get_counts())
+# Information on the parallelization and underlying jobs is also available.
+print(f"On average, {job.info.avg_circuits_per_backend} circuits were placed per backend.")
+print("Job IDs:")
+for job_id in job.job_id():
+    print(f" - {job_id}")
+```
+
+For an operational overview, see this diagram:
+
+![](./notebooks/parallelizer-full.drawio.png)
+
+## Development setup
+
+For the following commands, a virtual environment or equivalent isolation is recommended. This can
+be done with Conda, for example, with
+```bash
+conda create --name parallelizer python=3.10 pip # note the Python version!
+conda activate parallelizer
+```
+
+The package can then be installed from a local copy of the directory by running
+
+```bash
+pip install -e .
+```
+
+from the repository root. If you additionally wish to run tests or the provided notebook(s), you
+can install dependencies for those with
+
+```bash
+pip install .[tests]
+# and/or
+pip install .[notebooks]
+```
+
+## Testing
+
+Running all tests is as simple as installing the required dependencie (`.[tests]`) and running
+
+```bash
+pytest
+```
+
+from the repository root. Additionally, there is a benchmarking script in the `tests/` directory.
+
+## Authors
+
+- **Henri Ahola** - henri.ahola@vtt.fi

qc_parallelizer-1.0.0/README.md

@@ -0,0 +1,79 @@
+# Quantum Circuit Parallelizer
+
+A Python module for optimally combining and distributing quantum circuits. See the
+[included notebooks](./notebooks/) for examples and more information. In summary, the motivation
+for this module comes from frequent underutilization of increasingly large quantum processors. The
+module processes several independent circuits into a smaller set of wider, combined circuits, which
+it then runs on available backends in parallel. All of this happens behind the scenes, so ideally
+the user can treat the module's functionality as a parallelized drop-in replacement for Qiskit's
+`backend.run()`.
+
+Here is a brief and basic example:
+
+```python
+# Define or load a number of circuits.
+from qiskit import QuantumCircuit
+circuits = [QuantumCircuit(...), QuantumCircuit(...), ...]
+
+# Define backends for circuit execution. These can be any Qiskit-compatible backend objects, but
+# here we define two simulators that mimic IQM's 5-qubit Adonis architechture.
+import iqm.qiskit_iqm as iqm
+backends = [iqm.IQMFakeAdonis(), iqm.IQMFakeAdonis()]
+
+# Parallelize and execute. This call will
+#  1. determine how to combine the circuits and for which backends, and
+#  2. submit jobs to the backends.
+import qc_parallelizer as parallelizer
+job = parallelizer.execute(circuits, backends=backends)
+
+# Fetch and handle results. This plots the first circuit's result histogram, for example.
+results = job.results()
+qiskit.visualization.plot_histogram(result[0].get_counts())
+# Information on the parallelization and underlying jobs is also available.
+print(f"On average, {job.info.avg_circuits_per_backend} circuits were placed per backend.")
+print("Job IDs:")
+for job_id in job.job_id():
+    print(f" - {job_id}")
+```
+
+For an operational overview, see this diagram:
+
+![](./notebooks/parallelizer-full.drawio.png)
+
+## Development setup
+
+For the following commands, a virtual environment or equivalent isolation is recommended. This can
+be done with Conda, for example, with
+```bash
+conda create --name parallelizer python=3.10 pip # note the Python version!
+conda activate parallelizer
+```
+
+The package can then be installed from a local copy of the directory by running
+
+```bash
+pip install -e .
+```
+
+from the repository root. If you additionally wish to run tests or the provided notebook(s), you
+can install dependencies for those with
+
+```bash
+pip install .[tests]
+# and/or
+pip install .[notebooks]
+```
+
+## Testing
+
+Running all tests is as simple as installing the required dependencie (`.[tests]`) and running
+
+```bash
+pytest
+```
+
+from the repository root. Additionally, there is a benchmarking script in the `tests/` directory.
+
+## Authors
+
+- **Henri Ahola** - henri.ahola@vtt.fi