Qiskit addon: multi-product formulas (MPF)
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 multi-product formulas (MPFs). These can be used to reduce the Trotter error of Hamiltonian dynamics.
This package currently contains the following main entry points for users:
qiskit_addon_mpf.staticfor working with static MPFs 1-2qiskit_addon_mpf.dynamicfor working with dynamic MPFs 2-3
Documentation
All documentation is available at https://qiskit.github.io/qiskit-addon-mpf/.
Installation
We encourage installing this package via pip, when possible:
pip install 'qiskit-addon-mpf'
For more installation information refer to these installation instructions.
Optional dependencies
The qiskit-addon-mpf package has a number of optional dependencies which enable certain features.
The dynamic MPF feature (see 2-3) is one such example.
You can install the related optional dependencies like so:
pip install 'qiskit-addon-mpf[dynamic]'
[!IMPORTANT] The optional dependency TeNPy was previously offered under a GPLv3 license. As of the release of v1.0.4 on October 2nd, 2024, it has been offered under the Apache v2 license. The license of this package is only compatible with Apache-licensed versions of TeNPy.
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.
References
- A. Carrera Vazquez, D. J. Egger, D. Ochsner, and S. Wörner, Well-conditioned multi-product formulas for hardware-friendly Hamiltonian simulation, Quantum 7, 1067 (2023).
- S. Zhuk, N. Robertson, and S. Bravyi, Trotter error bounds and dynamic multi-product formulas for Hamiltonian simulation, Phys. Rev. Research 6, 033309 (2024).
- N. Robertson, et al. Tensor Network enhanced Dynamic Multiproduct Formulas, arXiv:2407.17405v2 [quant-ph].
License
Metadata
Release files for qiskit-addon-mpf 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qiskit_addon_mpf-0.3.0.tar.gz | 809.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qiskit_addon_mpf-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 878.0 kB
Release files / qiskit_addon_mpf-0.3.0.tar.gz
| Download URL | qiskit_addon_mpf-0.3.0.tar.gz |
|---|---|
| Size | 809.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
89ac87e1af4b3a8665dae683be258142ee395cd361b2cd9012c8e77107799329
|
|
BLAKE2b-256 checksum How to use checksums |
30326da4e24c27927cd0402e6a04773f6bd15f0ad06a4a44f638531c060d79c9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
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 Mar 20, 2025.
Transparency logRelease files / qiskit_addon_mpf-0.3.0-py3-none-any.whl
| Download URL | qiskit_addon_mpf-0.3.0-py3-none-any.whl |
|---|---|
| Size | 68.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2bd7856e8a89b6a584780d34eb9ab1444e03a2f19ed99027467d14690e0beb51
|
|
BLAKE2b-256 checksum How to use checksums |
3adbef6d943180b825f68a951b0901b7a4188f911549c9b7b77c630ea5158688
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
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 Mar 20, 2025.
Transparency log