Skip to main content

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

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qiskit_addon_mpf-0.3.0.tar.gz (809.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qiskit_addon_mpf-0.3.0-py3-none-any.whl (68.9 kB view details)

Uploaded Python 3

File details

Details for the file qiskit_addon_mpf-0.3.0.tar.gz.

File metadata

  • Download URL: qiskit_addon_mpf-0.3.0.tar.gz
  • Upload date:
  • Size: 809.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for qiskit_addon_mpf-0.3.0.tar.gz
Algorithm Hash digest
SHA256 89ac87e1af4b3a8665dae683be258142ee395cd361b2cd9012c8e77107799329
MD5 78eff8f80314dd800fda49d308b3eaa0
BLAKE2b-256 30326da4e24c27927cd0402e6a04773f6bd15f0ad06a4a44f638531c060d79c9

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_addon_mpf-0.3.0.tar.gz:

Publisher: release.yml on Qiskit/qiskit-addon-mpf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qiskit_addon_mpf-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for qiskit_addon_mpf-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2bd7856e8a89b6a584780d34eb9ab1444e03a2f19ed99027467d14690e0beb51
MD5 c2d122969b9018d338cd49dc49b7c612
BLAKE2b-256 3adbef6d943180b825f68a951b0901b7a4188f911549c9b7b77c630ea5158688

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_addon_mpf-0.3.0-py3-none-any.whl:

Publisher: release.yml on Qiskit/qiskit-addon-mpf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page