ffsim
ffsim is a software library for simulating fermionic quantum circuits that conserve particle number and the z component of spin. This category includes many quantum circuits used for quantum chemistry simulations. By exploiting the symmetries and using specialized algorithms, ffsim can simulate these circuits much faster than a generic quantum circuit simulator.
Documentation
Documentation is located at the project website. You might also be interested in the paper about ffsim.
Installation
On Linux and macOS, you can install ffsim using pip:
pip install ffsim
See the installation instructions for information about using ffsim on Windows, as well as instructions for installing from source and running ffsim in a container.
Get started
Visit State vectors and gates to start learning ffsim's core concepts, or jump straight into a tutorial. Check out the guides for help with specific tasks, or visit the API reference for detailed documentation of all function and classes available in the library.
Multithreading
Some ffsim functions implemented in Rust use multithreading. The number of threads can be controlled using the environment variable RAYON_NUM_THREADS. For example, to disable multithreading, set this variable as RAYON_NUM_THREADS=1.
Code example
import numpy as np
import pyscf
import ffsim
# Generate the Hamiltonian for an N2 molecule using PySCF and ffsim's wrapper for it
mol = pyscf.gto.Mole()
mol.build(atom=[["N", (0, 0, 0)], ["N", (1.0, 0, 0)]], basis="6-31g", symmetry="Dooh")
scf = pyscf.scf.RHF(mol).run()
mol_data = ffsim.MolecularData.from_scf(scf, active_space=range(4, mol.nao_nr()))
norb, nelec = mol_data.norb, mol_data.nelec
hamiltonian = mol_data.hamiltonian
# Convert the Hamiltonian to a SciPy LinearOperator
linop = ffsim.linear_operator(hamiltonian, norb=norb, nelec=nelec)
# Generate a random orbital rotation
orbital_rotation = ffsim.random.random_unitary(norb, seed=1234)
# Create the Hartree-Fock state and apply the orbital rotation to it
vec = ffsim.hartree_fock_state(norb, nelec)
vec = ffsim.apply_orbital_rotation(vec, orbital_rotation, norb=norb, nelec=nelec)
# Compute the energy of the state
energy = np.vdot(vec, linop @ vec).real
print(energy) # prints -104.17181289596
Citing ffsim
You can cite ffsim using the following BibTeX:
@misc{sung2026ffsim,
title={ffsim: Faster simulation of fermionic quantum circuits},
author={Kevin J. Sung and Inho Choi and Mirko Amico and Bartholomew Andrews and Esra Ayantuna and Yukio Kawashima and Wan-Hsuan Lin and David Omanovic and Samuele Piccinelli and Javier Robledo Moreno and Abdullah Ash Saki and James Shee and Soyoung Shin and Minh C. Tran and Kento Ueda and Haimeng Zhang and Mario Motta},
year={2026},
eprint={2605.03123},
archivePrefix={arXiv},
primaryClass={quant-ph},
url={https://arxiv.org/abs/2605.03123},
}
Developer guide
See the developer guide for instructions on contributing code to ffsim.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ffsim-0.0.82.tar.gz.
File metadata
- Download URL: ffsim-0.0.82.tar.gz
- Upload date:
- Size: 1.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b2f2570a93a84b1b0045c519b39f4adecaff884b63346b55de8da971737a87c0
|
|
| MD5 |
9731dfd81409315cc1a20d067fb28124
|
|
| BLAKE2b-256 |
7f47af57e47d851c716f1bdb252b570ea38e459c539adaf3b6a729356d7d44d4
|
Provenance
The following attestation bundles were made for ffsim-0.0.82.tar.gz:
Publisher:
build-and-release.yml on qiskit-community/ffsim
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ffsim-0.0.82.tar.gz -
Subject digest:
b2f2570a93a84b1b0045c519b39f4adecaff884b63346b55de8da971737a87c0 - Sigstore transparency entry: 2191850382
- Sigstore integration time:
-
Permalink:
qiskit-community/ffsim@a5402aeea318d3bac95357aa3b24fdc191323df8 -
Branch / Tag:
refs/tags/v0.0.82 - Owner: https://github.com/qiskit-community
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-and-release.yml@a5402aeea318d3bac95357aa3b24fdc191323df8 -
Trigger Event:
release
-
Statement type:
File details
Details for the file ffsim-0.0.82-cp311-abi3-manylinux_2_28_x86_64.whl.
File metadata
- Download URL: ffsim-0.0.82-cp311-abi3-manylinux_2_28_x86_64.whl
- Upload date:
- Size: 742.8 kB
- Tags: CPython 3.11+, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9cab1f74a21488c4fe7a73f4d8dbdfe3465ed82d7e7ed4302564304906b54ecc
|
|
| MD5 |
339bfc4030ad20e1a7671b9953e94572
|
|
| BLAKE2b-256 |
e700464ce4007476a923614c61eb338e6327afecbfdcd1dd6fdd28cf5ed489fc
|
Provenance
The following attestation bundles were made for ffsim-0.0.82-cp311-abi3-manylinux_2_28_x86_64.whl:
Publisher:
build-and-release.yml on qiskit-community/ffsim
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ffsim-0.0.82-cp311-abi3-manylinux_2_28_x86_64.whl -
Subject digest:
9cab1f74a21488c4fe7a73f4d8dbdfe3465ed82d7e7ed4302564304906b54ecc - Sigstore transparency entry: 2191850389
- Sigstore integration time:
-
Permalink:
qiskit-community/ffsim@a5402aeea318d3bac95357aa3b24fdc191323df8 -
Branch / Tag:
refs/tags/v0.0.82 - Owner: https://github.com/qiskit-community
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-and-release.yml@a5402aeea318d3bac95357aa3b24fdc191323df8 -
Trigger Event:
release
-
Statement type:
File details
Details for the file ffsim-0.0.82-cp311-abi3-manylinux_2_28_aarch64.whl.
File metadata
- Download URL: ffsim-0.0.82-cp311-abi3-manylinux_2_28_aarch64.whl
- Upload date:
- Size: 736.0 kB
- Tags: CPython 3.11+, manylinux: glibc 2.28+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
55337908730c1a5f7f8bbe022d75e54593a99ff6a65af768e4887f3b0e4f5119
|
|
| MD5 |
3ddc2bf64c9816b9087c3fcc8cf16db1
|
|
| BLAKE2b-256 |
5d7d886fe88ca597defc07d78f1e765df50e78c716cf4603900c92154472ec15
|
Provenance
The following attestation bundles were made for ffsim-0.0.82-cp311-abi3-manylinux_2_28_aarch64.whl:
Publisher:
build-and-release.yml on qiskit-community/ffsim
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ffsim-0.0.82-cp311-abi3-manylinux_2_28_aarch64.whl -
Subject digest:
55337908730c1a5f7f8bbe022d75e54593a99ff6a65af768e4887f3b0e4f5119 - Sigstore transparency entry: 2191850392
- Sigstore integration time:
-
Permalink:
qiskit-community/ffsim@a5402aeea318d3bac95357aa3b24fdc191323df8 -
Branch / Tag:
refs/tags/v0.0.82 - Owner: https://github.com/qiskit-community
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-and-release.yml@a5402aeea318d3bac95357aa3b24fdc191323df8 -
Trigger Event:
release
-
Statement type:
File details
Details for the file ffsim-0.0.82-cp311-abi3-macosx_11_0_arm64.whl.
File metadata
- Download URL: ffsim-0.0.82-cp311-abi3-macosx_11_0_arm64.whl
- Upload date:
- Size: 678.2 kB
- Tags: CPython 3.11+, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5abbed6ca4f0549c98740dd83e560df36ae8ccab707df260aa4f6e9ba03ad454
|
|
| MD5 |
ddeef2fdc71ad8a908de81aff1463e45
|
|
| BLAKE2b-256 |
f92303d57ce56b3a90ff938dfaa208f2c9b62736617be023e478abac2b410108
|
Provenance
The following attestation bundles were made for ffsim-0.0.82-cp311-abi3-macosx_11_0_arm64.whl:
Publisher:
build-and-release.yml on qiskit-community/ffsim
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ffsim-0.0.82-cp311-abi3-macosx_11_0_arm64.whl -
Subject digest:
5abbed6ca4f0549c98740dd83e560df36ae8ccab707df260aa4f6e9ba03ad454 - Sigstore transparency entry: 2191850396
- Sigstore integration time:
-
Permalink:
qiskit-community/ffsim@a5402aeea318d3bac95357aa3b24fdc191323df8 -
Branch / Tag:
refs/tags/v0.0.82 - Owner: https://github.com/qiskit-community
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-and-release.yml@a5402aeea318d3bac95357aa3b24fdc191323df8 -
Trigger Event:
release
-
Statement type:
