Skip to main content

Qiskit addon: optimization modeling

Table of contents


About

Qiskit addons are a collection of modular tools for building utility-scale workloads powered by Qiskit.

This package contains the Qiskit addon for optimization modeling. Quantum computers have the potential to solve combinatorial optimization problems [1]. These optimization problems can be formulated in an abstract model and then converted into a representation that a quantum computer can understand, for instance a Hamiltonian operator.

The optimization workflow first involves formulating the optimization problem in mathematical terms. This requires defining the objective function to either maximize or minimize and adding any constraints that the decision variables must satisfy. The variables may be continuous, integare, binary or spin-like. Furthermore, the constraints on the variables are typically formulated as equalities and inequalities. Second, this mathematical model is often reformulated into an unconstrained form by transforming the constraints into penalty terms. Third, the decision variables may be converted into a desired format. For example, integer variables may the transformed into binary variables so that the resulting model is either quadratic unconstrained binary optimization (QUBO) problem or a higher-order unconstrained binary optimization (HUBO) problem. In this package the term higher-order is used to designed any polynomial or monomial with a degree higher than two. Finally, the model is translated into a format that a quantum computer can understand. Typically, this implies creating a Hamiltonian operator whose ground state corresponds to the solution of the original optimization problem.


Documentation

All documentation is available at https://qiskit.github.io/qiskit-addon-opt-mapper


Installation

We encourage installing this package via pip, when possible:

pip install qiskit-addon-opt-mapper

For more installation information refer to these installation instructions.


Computational requirements

The most computationally expensive part of the addon is the computation of the objective function for large combinatorial optimization problems.


Deprecation Policy

We follow semantic versioning and are guided by the principles in Qiskit's deprecation policy. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the release notes.


Contributing

The source code is available on GitHub.

The developer guide is located at CONTRIBUTING.md in the root of this project's repository. By participating, you are expected to uphold Qiskit's code of conduct.

We use GitHub issues for tracking requests and bugs.


License

Apache License 2.0

References

[1] Abbas, et al. Challenges and opportunities in quantum optimization, Nat. Rev. Physics 6, 718-735 (2024).

Metadata

Release files for qiskit-addon-opt-mapper 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qiskit-addon-opt-mapper 0.1.0
File Size Uploaded
qiskit_addon_opt_mapper-0.1.0.tar.gz 204.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for qiskit-addon-opt-mapper 0.1.0
File Interpreter ABI Platform
qiskit_addon_opt_mapper-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 332.5 kB

Release files / qiskit_addon_opt_mapper-0.1.0.tar.gz

Download URL qiskit_addon_opt_mapper-0.1.0.tar.gz
Size 204.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3a9e4e2a5579d100579d05d8ae59a4cf4ef33493df287593114daa008890d624
BLAKE2b-256 checksum
How to use checksums
e6232221fef90651791c2b9c136a0059e302782b69ff0002bf292c7222ec74a3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 3, 2025.

Transparency log

Release files / qiskit_addon_opt_mapper-0.1.0-py3-none-any.whl

Download URL qiskit_addon_opt_mapper-0.1.0-py3-none-any.whl
Size 127.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5cc070c7ba5dc9f5e0289a142147cfcdc52f90cde5fe8c44fc62de1181cb096c
BLAKE2b-256 checksum
How to use checksums
986f1ca962bb1800d43bd22a5095c81d2a51c634e5e40399e4942e0d6235a074
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 3, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page