License Docs Qiskit Python rustc Platform Tests Coverage

Qiskit Fermions

qiskit-fermions extends the Qiskit SDK with tools for working on fermionic systems. Within its scope it provides:

  • efficient data structures for the representation and manipulation of fermionic operators in different forms
  • a framework for implementing operator conversion methods (including fermion-to-qubit encodings)
  • a library of efficient implementations of common conversion methods
  • a framework and library of gates for expressing fermionic circuits
  • a transpilation pipeline integrated with the Qiskit transpiler process to synthesize fermionic circuits into qubit-based circuits

Additionally, qiskit-fermions integrates with other tools of the ecosystem, such as:

  • ffsim for efficient simulation of fermionic circuits

Documentation

Documentation for this package is available on IBM Quantum Platform.

Installation

C

Please refer to the C installation instructions.

Python

We encourage installing this package via pip, when possible:

pip install 'qiskit-fermions'

For more installation information, refer to these installation instructions.

Getting started

Several guides exist to help you get started with this package. A good starting point to get an overview of its breadth of features is the 1D Fermi-Hubbard guide.

Use case examples

Components of this package have been used in research related to the following papers:

  • The qDRIFT randomized circuit compilation in 1.
  • The fermion-to-qubit synthesis during the transpilation process in 2.

Technical discussion

Design intentions

This package is deliberately designed to align with Qiskit: it builds on a core implemented in Rust and provides first-party language bindings to Python and C. Its API intends to draw parallels to Qiskit in order to seamlessly integrate into the workflows of users with experience in programming Qiskit.

A core principle to the design of qiskit-fermions was the decoupling of its fermionic circuit representation from its qubitized form. To be more precise: the fermionic circuits are meaningful by themselves and do not require a mapping to qubit space to be interpretable. Furthermore, the fermionic circuit representation cannot make any assumptions about its fermion-to-qubit encoding applied later on. Consequently, while Jordan-Wigner retains a dominant position and role, it is not assumed to be the default fermion-to-qubit encoding.

Known issues

As long as the Qiskit C API has not yet reached feature parity with its Python API, some components of this package remain exclusive to its Python API, too. This includes the entire circuit library (qiskit_fermions.circuit) as well as transpiler passes (qiskit_fermions.transpiler).

Future work

  • Migrate the circuit library and transpiler passes into the Rust core (and provide a C API for interacting with them)
  • Extend the library of efficient operator conversion implementations
  • Extend the library of efficient operator data structures

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.

Citing this package

If you use this package in your research, use the CITATION.bib file in this project’s repository to cite the appropriate reference(s).

License

Apache License 2.0

Deprecation policy

We follow semantic versioning. 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.

References

  1. Samuele Piccinelli, et al., Quantum chemistry with provable convergence via randomized sample-based Krylov quantum diagonalization, arXiv:2508.02578 [quant-ph]. ↩

  2. Anthony Gandon, et al., Stabilizer-based quantum simulation of fermion dynamics with local qubit encodings, arXiv:2512.11418 [quant-ph]. ↩

Project links

Data verified by PyPI on Aug 14, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

Owner

PyPI data
Data sourced directly from PyPI's database.

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for mrossinek from gravatar.com mrossinek

GitHub Statistics

Data verified by PyPI on Aug 14, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.10

Provides Extra

all optimization simulation

Classifiers

Report project as malware

Download files

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

Source Distribution

qiskit_fermions-0.1.0.tar.gz (155.8 kB view details)

Uploaded Source

Built Distributions

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

qiskit_fermions-0.1.0-cp310-abi3-win_amd64.whl (1.5 MB view details)

Uploaded CPython 3.10+Windows x86-64

qiskit_fermions-0.1.0-cp310-abi3-manylinux_2_28_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ x86-64

qiskit_fermions-0.1.0-cp310-abi3-manylinux_2_28_aarch64.whl (1.8 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ ARM64

qiskit_fermions-0.1.0-cp310-abi3-macosx_11_0_arm64.whl (1.7 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

qiskit_fermions-0.1.0-cp310-abi3-macosx_10_12_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

Details for the file qiskit_fermions-0.1.0.tar.gz.

File metadata

  • Download URL: qiskit_fermions-0.1.0.tar.gz
  • Upload date:
  • Size: 155.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for qiskit_fermions-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4151ee7e985f1ef9302a32c6afc34a189e40e681042615637a95e817d75389a7
MD5 de5913612a2e0baece8a5acd4de26c18
BLAKE2b-256 6b5680d54f9071b919e0c0a9702647d1fc1c8cd68683dbb28865fe5f83605344

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_fermions-0.1.0.tar.gz:

Publisher: release.yml on Qiskit/qiskit-fermions

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_fermions-0.1.0-cp310-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for qiskit_fermions-0.1.0-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 efad7d28d9d4f170efd0e33eda44a69489fc615233e0b6d13a3a75b9c1298da1
MD5 766978dd47abc7c1f4db11ff7d2203a6
BLAKE2b-256 1000dff0e0e42f43797574b6297d4bebc35d01142c31dfe7cadf15da94ca6bdd

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_fermions-0.1.0-cp310-abi3-win_amd64.whl:

Publisher: release.yml on Qiskit/qiskit-fermions

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_fermions-0.1.0-cp310-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for qiskit_fermions-0.1.0-cp310-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 1283ef766953d57ffa4e5ce14b069f95dbf1a0829983cf72c9ffe35c54c25153
MD5 7d2afd40ddbd5ae093e2a32972869c13
BLAKE2b-256 83b5a8ba0290d4211710a8473a2f6c1a59a0b4765a36ca3194601a79bdaa3a7e

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_fermions-0.1.0-cp310-abi3-manylinux_2_28_x86_64.whl:

Publisher: release.yml on Qiskit/qiskit-fermions

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_fermions-0.1.0-cp310-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for qiskit_fermions-0.1.0-cp310-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 94abeb484f5827fc8ca11f9d8f75d08518cc72c27ea249510938438d5bda32f6
MD5 ff1448fd915165bf4c9aa849e8532277
BLAKE2b-256 5b124e6ced3efa011e57e0533539d64f6a0753f4e28ea0d409ae7cf2f035c8c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_fermions-0.1.0-cp310-abi3-manylinux_2_28_aarch64.whl:

Publisher: release.yml on Qiskit/qiskit-fermions

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_fermions-0.1.0-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for qiskit_fermions-0.1.0-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 6474b7f34d7c0a8950bb03268174a9efa739adfe3bc8419c5813400357509c5d
MD5 bd5c6654b880c03b9f386fff430ccca7
BLAKE2b-256 354b8fa54b2f43eb4bd5f75cd4dead85eebc145e436a4588b25caa0611063dbd

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_fermions-0.1.0-cp310-abi3-macosx_11_0_arm64.whl:

Publisher: release.yml on Qiskit/qiskit-fermions

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_fermions-0.1.0-cp310-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for qiskit_fermions-0.1.0-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 84e7ec750c844c89277a7cffd14a8aeb1a1d930351bf050dffd625dec754cd4d
MD5 18b354accf1fb69bd400cad6e99bcc6c
BLAKE2b-256 b6610cbb9f5d7ad5dd83ffe6b96ca1a326ba904a40d67d9ac94b327a590f8576

See more details on using hashes here.

Provenance

The following attestation bundles were made for qiskit_fermions-0.1.0-cp310-abi3-macosx_10_12_x86_64.whl:

Publisher: release.yml on Qiskit/qiskit-fermions

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 Sentry Error logging StatusPage Status page