mqt-qubomaker

A framework for the automatic generation of QUBO formulations for optimization problems.

https://github.com/cda-tum/mqt-qubomaker

Science Score: 72.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: arxiv.org
  • Committers with academic emails
    1 of 5 committers (20.0%) from academic institutions
  • Institutional organization owner
    Organization cda-tum has institutional domain (www.cda.cit.tum.de)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary

Keywords

optimization quantum-computing qubo

Keywords from Contributors

mesh spacy-extension hydrology regionalization energy-system exoplanet interactive genetic-algorithms optim data-profilers
Last synced: 4 months ago · JSON representation ·

Repository

A framework for the automatic generation of QUBO formulations for optimization problems.

Basic Info
Statistics
  • Stars: 26
  • Watchers: 3
  • Forks: 3
  • Open Issues: 13
  • Releases: 2
Topics
optimization quantum-computing qubo
Created about 2 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing License Citation Support

README.md

PyPI OS License: MIT CI CD Documentation codecov

MQT QUBOMaker: Automatic Generation of QUBO Formulations from Optimization Problem Specifications

MQT QUBOMaker is a framework that can be used to automatically generate QUBO formulations for various optimization problems based on a selection of constraints that define the problem. It is developed by the Chair for Design Automation at the Technical University of Munich as part of the Munich Quantum Toolkit (MQT).

The tool allows users to create QUBO formulations, and, thus, interact with quantum algorithms, without requiring any background knowledge in the field of quantum computing. End-users can stay entirely within their domain of expertise while being shielded from the complex and error-prone mathematical tasks of QUBO reformulation.

Furthermore, MQT QUBOMaker supports a variety of different encodings. End users can easily switch between the encodings for evaluation purposes without any additional effort, a task that would otherwise require a large amount of tedious mathematical reformulation.

Currently, MQT QUBOMaker provides the following submodule:

  • Pathfinder: This submodule provides a specialization of the QUBOMaker class for the solution of optimization problems involving the search for paths in a directed graph. It provides a large set of pathfinding-related constraints that are used to define individual problem instances.

The Pathfinder submodule also has a supporting GUI to further facilitate its use.

For more details, please refer to:

Documentation

If you have any questions, feel free to create a discussion or an issue on GitHub.

Getting Started

mqt-qubomaker is available via PyPI.

console (venv) $ pip install mqt.qubomaker

The following code gives an example of the usage with the pathfinder submodule:

```python3 import mqt.qubomaker as qm import mqt.qubomaker.pathfinder as pf

define an example graph to investigate.

graph = qm.Graph.fromadjacencymatrix( [ [0, 1, 3, 4], [2, 0, 4, 2], [1, 5, 0, 3], [3, 8, 1, 0], ] )

select the settings for the QUBO formulation.

settings = pf.PathFindingQUBOGeneratorSettings( encodingtype=pf.EncodingType.ONEHOT, npaths=1, maxpath_length=4, loops=True )

define the generator to be used for the QUBO formulation.

generator = pf.PathFindingQUBOGenerator( objectivefunction=pf.MinimizePathLength(pathids=[1]), graph=graph, settings=settings, )

add the constraints that define the problem instance.

generator.addconstraint(pf.PathIsValid(pathids=[1])) generator.addconstraint( pf.PathContainsVerticesExactlyOnce(vertexids=graph.allvertices, pathids=[1]) )

generate and view the QUBO formulation as a QUBO matrix.

print(generator.constructqubomatrix()) ```

Detailed documentation and examples are available at ReadTheDocs.

References

MQT QUBOMaker has been developed based on methods proposed in the following paper:

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.

TUM Logo Coat of Arms of Bavaria ERC Logo MQV Logo

Owner

  • Name: Chair for Design Automation, TU Munich
  • Login: cda-tum
  • Kind: organization
  • Location: Germany

The CDA provides expertise for all main steps in the design and realization of integrated circuits, embedded systems, as well as cyber-physical systems.

Citation (CITATION.bib)

@MISC{rovara2024pathfindingframework,
	AUTHOR      = {Damian Rovara and Nils Quetschlich and Robert Wille},
	TITLE       = {A Framework to Formulate Pathfinding Problems for Quantum Computing},
	YEAR        = {2024},
	EPRINT      = {2404.10820},
	EPRINTTYPE  = {arxiv},
}

GitHub Events

Total
  • Watch event: 12
  • Delete event: 60
  • Issue comment event: 53
  • Push event: 157
  • Pull request review event: 11
  • Pull request event: 136
  • Fork event: 1
  • Create event: 72
Last Year
  • Watch event: 12
  • Delete event: 60
  • Issue comment event: 53
  • Push event: 157
  • Pull request review event: 11
  • Pull request event: 136
  • Fork event: 1
  • Create event: 72

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 243
  • Total Committers: 5
  • Avg Commits per committer: 48.6
  • Development Distribution Score (DDS): 0.527
Past Year
  • Commits: 110
  • Committers: 5
  • Avg Commits per committer: 22.0
  • Development Distribution Score (DDS): 0.427
Top Committers
Name Email Commits
Damian Rovara d****a@t****e 115
renovate[bot] 2****] 63
pre-commit-ci[bot] 6****] 30
dependabot[bot] 4****] 23
burgholzer b****r@m****m 12
Committer Domains (Top 20 + Academic)
me.com: 1 tum.de: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 1
  • Total pull requests: 143
  • Average time to close issues: N/A
  • Average time to close pull requests: 13 days
  • Total issue authors: 1
  • Total pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.82
  • Merged pull requests: 118
  • Bot issues: 1
  • Bot pull requests: 142
Past Year
  • Issues: 1
  • Pull requests: 131
  • Average time to close issues: N/A
  • Average time to close pull requests: 14 days
  • Issue authors: 1
  • Pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.73
  • Merged pull requests: 107
  • Bot issues: 1
  • Bot pull requests: 130
Top Authors
Issue Authors
  • DRovara (1)
  • renovate[bot] (1)
  • pre-commit-ci[bot] (1)
Pull Request Authors
  • renovate[bot] (135)
  • pre-commit-ci[bot] (48)
  • dependabot[bot] (19)
  • DRovara (7)
  • burgholzer (3)
  • q-inho (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (186) pre-commit (93) python (34) github_actions (18) github-actions (9) documentation (2) continuous integration (1) enhancement (1)

Dependencies

.github/workflows/codeql.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/coverage.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
.github/workflows/deploy.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/mypy.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • pre-commit/action v3.0.0 composite
.github/workflows/release-drafter.yml actions
  • release-drafter/release-drafter v5 composite
pyproject.toml pypi
  • docplex *
  • joblib *
  • matplotlib *
  • mqt.ddsim *
  • networkx *
  • numpy *
  • python_tsp *
  • qiskit >=0.36.0,<=0.45.0
  • qiskit_optimization *
  • sympy *
  • tsplib95 *