mqt.problemsolver 0.2.0__tar.gz → 0.3.0__tar.gz

{mqt.problemsolver-0.2.0 → mqt.problemsolver-0.3.0}/.github/codecov.yml

@@ -1,3 +1,6 @@
+ignore:
+  - "tests/**/*"
+
 coverage:
   range: 60..90
   precision: 1

{mqt.problemsolver-0.2.0 → mqt.problemsolver-0.3.0}/.github/workflows/coverage.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Install MQT ProblemSolver
         run: pip install .[coverage]
       - name: Generate Report
-        run: pytest -v --cov=./ --cov-report=xml
+        run: pytest -v --cov --cov-config=pyproject.toml --cov-report=xml
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:

{mqt.problemsolver-0.2.0 → mqt.problemsolver-0.3.0}/.pre-commit-config.yaml

@@ -15,7 +15,7 @@ ci:
 repos:
   # Standard hooks
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v4.4.0"
+    rev: "v4.5.0"
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -32,28 +32,14 @@ repos:
 
   # Handling unwanted unicode characters
   - repo: https://github.com/sirosen/texthooks
-    rev: "0.5.0"
+    rev: "0.6.3"
     hooks:
       - id: fix-ligatures
       - id: fix-smartquotes
 
-  # Run code formatting with Black
-  - repo: https://github.com/psf/black
-    rev: "23.3.0" # Keep in sync with blacken-docs
-    hooks:
-      - id: black
-
-  # Also run Black on examples in the documentation
-  - repo: https://github.com/asottile/blacken-docs
-    rev: "1.13.0"
-    hooks:
-      - id: blacken-docs
-        additional_dependencies:
-          - black==23.3.0 # keep in sync with black hook
-
   # Check for spelling
   - repo: https://github.com/codespell-project/codespell
-    rev: "v2.2.4"
+    rev: "v2.2.6"
     hooks:
       - id: codespell
         args: ["-L", "wille,linz"]
@@ -64,25 +50,35 @@ repos:
 
   # Format configuration files with prettier
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.0.0-alpha.9-for-vscode"
+    rev: "v4.0.0-alpha.8"
     hooks:
       - id: prettier
         types_or: [yaml, markdown, html, css, javascript, json]
 
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.263
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.13
     hooks:
       - id: ruff
-        args: ["--fix"]
+        args: ["--fix", "--show-fixes"]
+        types_or: [python, pyi, jupyter]
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]
+
+  # Also run Black on examples in the documentation
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.16.0
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==23.*]
 
   # Clean jupyter notebooks
   - repo: https://github.com/srstevenson/nb-clean
-    rev: "2.4.0"
+    rev: "3.2.0"
     hooks:
       - id: nb-clean
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.2.0
+    rev: v1.8.0
     hooks:
       - id: mypy
         files: ^(src|tests|setup.py)

{mqt.problemsolver-0.2.0/src/mqt.problemsolver.egg-info → mqt.problemsolver-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mqt.problemsolver
-Version: 0.2.0
+Version: 0.3.0
 Summary: MQT ProblemSolver - A MQT tool for Solving Problems Using Quantum Computing
 Author-email: Nils Quetschlich <nils.quetschlich@tum.de>, Lukas Burgholzer <lukas.burgholzer@jku.at>
 Project-URL: Homepage, https://github.com/cda-tum/mqtproblemsolver
@@ -24,9 +24,23 @@ Classifier: Natural Language :: English
 Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+Requires-Dist: qiskit<0.42.0,>=0.36.0
+Requires-Dist: joblib
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: mqt.ddsim
+Requires-Dist: networkx
+Requires-Dist: python_tsp
+Requires-Dist: docplex
+Requires-Dist: qiskit_optimization
 Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
 Provides-Extra: coverage
+Requires-Dist: mqt.problemsolver[test]; extra == "coverage"
+Requires-Dist: coverage[toml]~=6.5.0; extra == "coverage"
+Requires-Dist: pytest-cov~=4.0.0; extra == "coverage"
 Provides-Extra: dev
+Requires-Dist: mqt.problemsolver[coverage]; extra == "dev"
 
 [![CodeCov](https://github.com/cda-tum/MQTProblemSolver/actions/workflows/coverage.yml/badge.svg)](https://github.com/cda-tum/MQTProblemSolver/actions/workflows/coverage.yml)
 [![Deploy to PyPI](https://github.com/cda-tum/MQTProblemSolver/actions/workflows/deploy.yml/badge.svg)](https://github.com/cda-tum/MQTProblemSolver/actions/workflows/deploy.yml)
@@ -99,12 +113,19 @@ Every quantum computing application must be encoded into a quantum circuit and t
 This lengthy compilation process is a key bottleneck and intensifies for recurring problems---each of which requires
 a new compilation run thus far.
 
+<p align="center">
+<img src="img/workflow_old.png">
+</p>
+
 Pre-compilation is a promising approach to overcome this bottleneck.
 Beginning with a problem class and suitable quantum algorithm, a **predictive encoding** scheme is applied to encode a
 representative problem instance into a general-purpose quantum circuit for that problem class.
 Once the real problem instance is known, the previously constructed circuit only needs to be
-**adjusted**—with (nearly) no compilation necessary.
+**adjusted**—with (nearly) no compilation necessary:
 
+<p align="center">
+<img src="img/workflow_new.png">
+</p>
 Following this approach, we provide a pre-compilation module that can be used to precompile QAOA circuits
 for the MaxCut problem.
 
@@ -123,18 +144,20 @@ MQT ProblemSolver is available via [PyPI](https://pypi.org/project/mqt.problemso
 ├── src
 │ └── mqt
 │     └── problemsolver
-│     │  └── csp.py
-│     │  └── tsp.py
-│     └── satelitesolver
-│     │  └── ...
-│     └── precompilation
-│        └── ...
+│        └── satelitesolver
+│        │   └── ...
+│        └── precompilation
+│        │   └── ...
+│        └── csp.py
+│        └── tsp.py
 └── notebooks
-│     └── problemsolver
-│        └── csp_example.ipynb
-│        └── tsp_example.ipynb
-│        └── satellitesolver
-│           └── satellitesolver_example.ipynb
+     └── satelitesolver
+     │   └── ...
+     └── precompilation
+     │   └── ...
+     └── problemsolver_paper_figures.ipynb
+     └── csp_example.ipynb
+     └── tsp_example.ipynb
 ```
 
 # References
@@ -143,9 +166,64 @@ In case you are using MQT ProblemSolver in your work, we would be thankful if yo
 
 ```bibtex
 @INPROCEEDINGS{quetschlich2023mqtproblemsolver,
-    author    = {N. Quetschlich and L. Burgholzer and R. Wille},
     title     = {{Towards an Automated Framework for Realizing Quantum Computing Solutions}},
+    author    = {N. Quetschlich and L. Burgholzer and R. Wille},
     booktitle = {International Symposium on Multiple-Valued Logic (ISMVL)},
     year      = {2023},
 }
 ```
+
+which is also available on arXiv:
+[![a](https://img.shields.io/static/v1?label=arXiv&message=2210.14928&color=inactive&style=flat-square)](https://arxiv.org/abs/2210.14928)
+
+In case you are using our Pre-Compilation approach, we would be thankful if you referred to it by citing the following publication:
+
+```bibtex
+@INPROCEEDINGS{quetschlich2023precompilation,
+    title     = {{Reducing the Compilation Time of Quantum Circuits Using Pre-Compilation on the Gate Level}},
+    author    = {N. Quetschlich and L. Burgholzer and R. Wille},
+    booktitle = {IEEE International Conference on Quantum Computing and Engineering (QCE)},
+    year      = {2023},
+}
+```
+
+which is also available on arXiv:
+[![a](https://img.shields.io/static/v1?label=arXiv&message=2305.04941&color=inactive&style=flat-square)](https://arxiv.org/abs/2305.04941)
+
+In case you are using our Satellite Mission Planning Problem approach, we would be thankful if you referred to it by citing the following publication:
+
+```bibtex
+@INPROCEEDINGS{quetschlich2023satellite,
+    title     = {{A Hybrid Classical Quantum Computing Approach to the Satellite Mission Planning Problem}},
+    author    = {N. Quetschlich and V. Koch and L. Burgholzer and R. Wille},
+    booktitle = {IEEE International Conference on Quantum Computing and Engineering (QCE)},
+    year      = {2023},
+}
+```
+
+which is also available on arXiv:
+[![a](https://img.shields.io/static/v1?label=arXiv&message=2308.00029&color=inactive&style=flat-square)](https://arxiv.org/abs/2308.00029)
+
+## Acknowledgements
+
+The Munich Quantum Toolkit has been supported by the European
+Research Council (ERC) under the European Union's Horizon 2020 research and innovation program (grant agreement
+No. 101001318), the Bavarian State Ministry for Science and Arts through the Distinguished Professorship Program, as well as the
+Munich Quantum Valley, which is supported by the Bavarian state government with funds from the Hightech Agenda Bayern Plus.
+
+<p align="center">
+<picture>
+<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/tum_dark.svg" width="28%">
+<img src="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/tum_light.svg" width="28%">
+</picture>
+<picture>
+<img src="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/logo-bavaria.svg" width="16%">
+</picture>
+<picture>
+<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/erc_dark.svg" width="24%">
+<img src="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/erc_light.svg" width="24%">
+</picture>
+<picture>
+<img src="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/logo-mqv.svg" width="28%">
+</picture>
+</p>

{mqt.problemsolver-0.2.0 → mqt.problemsolver-0.3.0}/README.md

@@ -69,12 +69,19 @@ Every quantum computing application must be encoded into a quantum circuit and t
 This lengthy compilation process is a key bottleneck and intensifies for recurring problems---each of which requires
 a new compilation run thus far.
 
+<p align="center">
+<img src="img/workflow_old.png">
+</p>
+
 Pre-compilation is a promising approach to overcome this bottleneck.
 Beginning with a problem class and suitable quantum algorithm, a **predictive encoding** scheme is applied to encode a
 representative problem instance into a general-purpose quantum circuit for that problem class.
 Once the real problem instance is known, the previously constructed circuit only needs to be
-**adjusted**—with (nearly) no compilation necessary.
+**adjusted**—with (nearly) no compilation necessary:
 
+<p align="center">
+<img src="img/workflow_new.png">
+</p>
 Following this approach, we provide a pre-compilation module that can be used to precompile QAOA circuits
 for the MaxCut problem.
 
@@ -93,18 +100,20 @@ MQT ProblemSolver is available via [PyPI](https://pypi.org/project/mqt.problemso
 ├── src
 │ └── mqt
 │     └── problemsolver
-│     │  └── csp.py
-│     │  └── tsp.py
-│     └── satelitesolver
-│     │  └── ...
-│     └── precompilation
-│        └── ...
+│        └── satelitesolver
+│        │   └── ...
+│        └── precompilation
+│        │   └── ...
+│        └── csp.py
+│        └── tsp.py
 └── notebooks
-│     └── problemsolver
-│        └── csp_example.ipynb
-│        └── tsp_example.ipynb
-│        └── satellitesolver
-│           └── satellitesolver_example.ipynb
+     └── satelitesolver
+     │   └── ...
+     └── precompilation
+     │   └── ...
+     └── problemsolver_paper_figures.ipynb
+     └── csp_example.ipynb
+     └── tsp_example.ipynb
 ```
 
 # References
@@ -113,9 +122,64 @@ In case you are using MQT ProblemSolver in your work, we would be thankful if yo
 
 ```bibtex
 @INPROCEEDINGS{quetschlich2023mqtproblemsolver,
-    author    = {N. Quetschlich and L. Burgholzer and R. Wille},
     title     = {{Towards an Automated Framework for Realizing Quantum Computing Solutions}},
+    author    = {N. Quetschlich and L. Burgholzer and R. Wille},
     booktitle = {International Symposium on Multiple-Valued Logic (ISMVL)},
     year      = {2023},
 }
 ```
+
+which is also available on arXiv:
+[![a](https://img.shields.io/static/v1?label=arXiv&message=2210.14928&color=inactive&style=flat-square)](https://arxiv.org/abs/2210.14928)
+
+In case you are using our Pre-Compilation approach, we would be thankful if you referred to it by citing the following publication:
+
+```bibtex
+@INPROCEEDINGS{quetschlich2023precompilation,
+    title     = {{Reducing the Compilation Time of Quantum Circuits Using Pre-Compilation on the Gate Level}},
+    author    = {N. Quetschlich and L. Burgholzer and R. Wille},
+    booktitle = {IEEE International Conference on Quantum Computing and Engineering (QCE)},
+    year      = {2023},
+}
+```
+
+which is also available on arXiv:
+[![a](https://img.shields.io/static/v1?label=arXiv&message=2305.04941&color=inactive&style=flat-square)](https://arxiv.org/abs/2305.04941)
+
+In case you are using our Satellite Mission Planning Problem approach, we would be thankful if you referred to it by citing the following publication:
+
+```bibtex
+@INPROCEEDINGS{quetschlich2023satellite,
+    title     = {{A Hybrid Classical Quantum Computing Approach to the Satellite Mission Planning Problem}},
+    author    = {N. Quetschlich and V. Koch and L. Burgholzer and R. Wille},
+    booktitle = {IEEE International Conference on Quantum Computing and Engineering (QCE)},
+    year      = {2023},
+}
+```
+
+which is also available on arXiv:
+[![a](https://img.shields.io/static/v1?label=arXiv&message=2308.00029&color=inactive&style=flat-square)](https://arxiv.org/abs/2308.00029)
+
+## Acknowledgements
+
+The Munich Quantum Toolkit has been supported by the European
+Research Council (ERC) under the European Union's Horizon 2020 research and innovation program (grant agreement
+No. 101001318), the Bavarian State Ministry for Science and Arts through the Distinguished Professorship Program, as well as the
+Munich Quantum Valley, which is supported by the Bavarian state government with funds from the Hightech Agenda Bayern Plus.
+
+<p align="center">
+<picture>
+<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/tum_dark.svg" width="28%">
+<img src="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/tum_light.svg" width="28%">
+</picture>
+<picture>
+<img src="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/logo-bavaria.svg" width="16%">
+</picture>
+<picture>
+<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/erc_dark.svg" width="24%">
+<img src="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/erc_light.svg" width="24%">
+</picture>
+<picture>
+<img src="https://raw.githubusercontent.com/cda-tum/mqt-problemsolver/main/img/logo-mqv.svg" width="28%">
+</picture>
+</p>