Skip to content

Reducing the Trotter error of Hamiltonian dynamics with multi-product formulas

License

Notifications You must be signed in to change notification settings

Qiskit/qiskit-addon-mpf

Release Platform Python Qiskit
Docs (stable)

License Downloads Tests Coverage

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.static for working with static MPFs 1-2
  • qiskit_addon_mpf.dynamic for 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

  1. 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).
  2. S. Zhuk, N. Robertson, and S. Bravyi, Trotter error bounds and dynamic multi-product formulas for Hamiltonian simulation, Phys. Rev. Research 6, 033309 (2024).
  3. N. Robertson, et al. Tensor Network enhanced Dynamic Multiproduct Formulas, arXiv:2407.17405v2 [quant-ph].

License

Apache License 2.0