Papers › OpenFermion: The Electronic Structure Package for Quantum Computers

OpenFermion: The Electronic Structure Package for Quantum Computers

20 Oct 2017arXiv:1710.07629links table onlyarchive 2025-07-28

Jarrod R. McClean, Kevin J. Sung, Ian D. Kivlichan, Yudong Cao, Chengyu Dai, E. Schuyler Fried, Craig Gidney, Brendan Gimby, Pranav Gokhale, Thomas Häner, Tarini Hardikar, Vojtěch Havlíček, Oscar Higgott, Cupjin Huang, Josh Izaac, Zhang Jiang, Xinle Liu, Sam McArdle, Matthew Neeley, Thomas O'Brien, Bryan O'Gorman, Isil Ozfidan, Maxwell D. Radin, Jhonathan Romero, Nicholas Rubin, Nicolas P. D. Sawaya, Kanav Setia, Sukin Sim, Damian S. Steiger, Mark Steudtner, Qiming Sun, Wei Sun, Daochen Wang, Fang Zhang, Ryan Babbush

The archive published only this paper's code-link row. Authors, date and abstract are from arXiv's metadata (CC0), read from the Kaggle arXiv metadata snapshot of 2026-09-12 where its title matched the archive's; the title is the archive's.

Quantum simulation of chemistry and materials is predicted to be an important application for both near-term and fault-tolerant quantum devices. However, at present, developing and studying algorithms for these problems can be difficult due to the prohibitive amount of domain knowledge required in both the area of chemistry and quantum algorithms. To help bridge this gap and open the field to more researchers, we have developed the OpenFermion software package (www.openfermion.org). OpenFermion is an open-source software library written largely in Python under an Apache 2.0 license, aimed at enabling the simulation of fermionic models and quantum chemistry problems on quantum hardware. Beginning with an interface to common electronic structure packages, it simplifies the translation between a molecular specification and a quantum circuit for solving or studying the electronic structure problem on a quantum computer, minimizing the amount of domain expertise required to enter the field. The package is designed to be extensible and robust, maintaining high software standards in documentation and testing. This release paper outlines the key motivations behind design choices in OpenFermion and discusses some basic OpenFermion functionality which we believe will aid the community in the development of better quantum algorithms and tools for this exciting area of research.

PaperPDFCodeCode Syntology ran

In Syntology View this paper on Syntology, its page in Syntology's graph. That page adds which of its functions are also present in other papers' code Syntology holds, with dates, and its dated run record as JSON and a README badge. It also lists the repositories linked to the paper, the abstract and the calls for agents.

Open this paper in Syntology's Atlas, the map of the papers in Syntology's graph and their citations.

For agents, on Syntology's MCP service (how to connect):

Code

Syntology 26 code samples harvested from 5 repositories linked to this paper: 24 ran (of which 0 constructed an object rather than computing a result; 24 with no instrument failure: 0 honoured, 0 violated, 24 with no contract checked; 0 where Syntology's instrument failed) · 2 unverified. “Where Syntology's instrument failed” counts failures of Syntology's instrument, not of the code; here there are none.

By repository: community (archive-listed): 26 samples from 5 repositories, 24 ran (24 with no instrument failure; 0 where Syntology's instrument failed). The run record, sample by sample. “Ran” means executed on a synthesized input, not that the code is correct or reproduces the paper.

Levels written on 2026-09-26 (UTC): the dates Syntology's graph wrote each sample's verification level, not when the code executed.

ProjectQ-Framework/FermiLib mentioned on GitHubApache-2.0Syntology: 2 samples, 2 ran (0 instrument-failed) · 0 unverified report
olansog/bidlabs-sherlock-fermion-code mentioned on GitHubApache-2.0Syntology: 6 samples, 6 ran (0 instrument-failed) · 0 unverified report
qchemsoftware/openfermion-qchem mentioned on GitHubApache-2.0Syntology: 6 samples, 6 ran (0 instrument-failed) · 0 unverified report
quantumlib/OpenFermion mentioned on GitHubApache-2.0Syntology: 9 samples, 7 ran (0 instrument-failed) · 2 unverified report
quantumlib/OpenFermion-Cirq mentioned on GitHubApache-2.0Syntology: not harvested report
quantumlib/OpenFermion-ProjectQ mentioned on GitHubApache-2.0Syntology: 3 samples, 3 ran (0 instrument-failed) · 0 unverified report
quantumlib/OpenFermion-Psi4 mentioned on GitHubLGPL-3.0Syntology: not harvested report
quantumlib/OpenFermion-PySCF mentioned on GitHubApache-2.0Syntology: not harvested report

Repository list and official/mentioned flags are the archive's, frozen 2025-07-28. Reachability, where shown, is from one Syntology probe window (2026-09-16 to 2026-09-18); repositories not probed show nothing. GitHub stars are not tracked.

Code Syntology ran Syntology

26 samples harvested: 24 ran (of which 0 constructed an object rather than computing a result; 24 with no instrument failure: 0 honoured, 0 violated, 24 with no contract checked; 0 where Syntology's instrument failed) · 2 unverified. “Where Syntology's instrument failed” counts failures of Syntology's instrument, not of the code. Syntology's record for this page has not changed since , the first build that kept a record date for it; when this build read Syntology's graph is in the build record. That date is not when the samples ran.

24ran
2unverified

Licence: 0 of the 26 samples are pointer only, meaning Syntology does not serve that copy's text. This page shows no code text for any sample; each one links to its file in the repository.

Harvested from 5 repositories linked to this paper, official or community; the list below is grouped by repository, each group headed by its name and what it is to the paper. “Ran” means the sample executed on a synthesized input. It does not mean the output is correct, and nothing here reproduces the paper's results. A line beginning “fixture:” under a sample that ran gives the arguments Syntology's fixture called the sample with, each as name:type/rank/element kind (? where none was recorded), and the type of what the fixture's run returned, exactly as the harness recorded them; the arguments and the returned type were recorded by two separate runs of the same fixture. No output value is shown, and a returned type says nothing about whether the output was right. “Level recorded” gives the UTC date when Syntology's graph wrote the sample's verification level, not when the code executed; where the level was written before Syntology's graph kept that date, the row says “level recorded, date not recorded”. “Honoured” and “violated” refer to a contract Syntology drafted from the code itself. “Our draft was wrong” and “the contract check could not run” are failures of Syntology's instrument, not of the code: the sample ran on Syntology's synthesized input, and then the drafted contract did not describe it, or the check itself raised an error (RAISES), lacked a dependency (DEP_MISSING) or ran out of time (TIMEOUT); hover the label for which. A metamorphic tier, where shown, is evidence of the output's shape, not that the sample implements the method.

Each sample ends with its code_sha256. A sample's code_sha256 is Syntology's identity for that exact code. It is printed in full (16 hexadecimal characters for every sample in this build), and get_code(code_sha256="…") takes it exactly as printed. An agent calls it on Syntology's MCP service (how to connect); click an identity to copy that call.

Repository labels, per sample. official repository: The archive marks this repository official for the paper. named in the paper: The archive records that the paper mentions this repository; it is not marked official. community (archive-listed): In the archive's code links for this paper, not marked official and not recorded as mentioned in the paper. found in paper text by Syntology: Syntology found this repository in the paper's own text; whether it is the authors' implementation is not asserted. community: Not in the archive's code links for this paper; a community repository Syntology harvested. Samples are grouped by repository: a repository marked official first, then by how directly the repository is tied to the paper, then in the archive's order; never by how many ran. Licence labels name the repository's licence as recorded at harvest. “Pointer only” means Syntology does not serve that copy's text, for one of six reasons: no licence file was found; the licence was not identified; the licence is recorded as permissive but that copy's record is not marked cleared; the licence is outside the permissive list Syntology serves text under (MIT, Apache-2.0, BSD and similar); this paper's copy was not located, so its licence is not recorded; or this paper's copy is cleared, but the stored copy of the same code that Syntology serves is not. Some licences outside that list permit redistribution, such as WTFPL, and GPL-3.0 under its conditions; they are simply not on the list. Hover a licence label for the reason. File links open the file on GitHub at the default branch, which may have changed since the harvest.

A function or class name links to its page when the name occurs in the harvested code of at least 5 papers; the name is a string, not an identity.

ProjectQ-Framework/FermiLib community (archive-listed) 2 samples, 2 ran (0 instrument-failed) · 0 unverified
one_body_basis_change src/fermilib/ops/_interaction_tensor.py ran Apache-2.0 (permissive) · 60dc74e8998881f1 · report fixture: signature one_body_tensor:ndarray/2/float, rotation_matrix:ndarray/2/float · returned ndarray · level recorded 2026-09-26
two_body_basis_change src/fermilib/ops/_interaction_tensor.py ran Apache-2.0 (permissive) · eed471709a9b0a3b · report fixture: signature two_body_tensor:ndarray/4/float, rotation_matrix:ndarray/2/float · returned ndarray · level recorded 2026-09-26
olansog/bidlabs-sherlock-fermion-code community (archive-listed) 6 samples, 6 ran (0 instrument-failed) · 0 unverified
abbreviate_command_arguments_after_switches dev_tools/shell_tools.py ran Apache-2.0 (permissive) · 179fd3eb8aebad25 · report fixture: signature cmd:tuple/1/str · returned tuple · level recorded 2026-09-26
diff_to_new_interesting_lines dev_tools/incremental_coverage.py ran Apache-2.0 (permissive) · a8daa6874ac569cb · report fixture: signature unified_diff_lines:list/1/str · returned dict · level recorded 2026-09-26
fix_line_from_coverage_file dev_tools/incremental_coverage.py ran fingerprinted Apache-2.0 (permissive) · c40e203f33e18343 · report fixture: signature line:str/0/str · returned str · level recorded 2026-09-26
highlight in 8 papers dev_tools/shell_tools.py ran Apache-2.0 (permissive) · bf7fa4434e39a565 · report fixture: signature text:str/0/str, color_code:int/0/int, bold:bool/0/bool · returned str · level recorded 2026-09-26
run_shell in 5 papers dev_tools/shell_tools.py ran Apache-2.0 (permissive) · f43b4c5d110c3d62 · report fixture: signature cmd:str/0/str, out:TextIOWrapper/0/?, err:TextIOWrapper/0/?, raise_on_fail:bool/0/bool, log_run_to_stderr:bool/0/bool · returned CommandOutput · level recorded 2026-09-26
shift_decoder src/openfermion/ops/_binary_code.py ran Apache-2.0 (permissive) · 69e0ebd0ee933c16 · report fixture: signature decoder:list/1/BinaryPolynomial, shift_constant:int/0/int · returned list · level recorded 2026-09-26
qchemsoftware/openfermion-qchem community (archive-listed) 6 samples, 6 ran (0 instrument-failed) · 0 unverified
bubble_sort openfermionqchem/_qchem_functiontools.py ran Apache-2.0 (permissive) · 8efd3f3201b09054 · report fixture: signature list1:list/1/int, list2:list/1/float · returned tuple · level recorded 2026-09-26
determinants openfermionqchem/_qchem_functiontools.py ran Apache-2.0 (permissive) · 6a28070450714bdd · report fixture: signature n_spin_orbs:int/0/int, n_eles:int/0/int, spin_flip:bool/0/bool · returned list · level recorded 2026-09-26
fact openfermionqchem/_qchem_functiontools.py ran fingerprinted Apache-2.0 (permissive) · 3d811e1576d60e4b · report fixture: signature n:int/0/int · returned int · level recorded 2026-09-26
fill_full_matrix openfermionqchem/_qchem_parser.py ran fingerprinted Apache-2.0 (permissive) · 598ac4505b0f44d0 · report fixture: signature lower_triangle:ndarray/1/float, nbas:int/0/int · returned ndarray · level recorded 2026-09-26
parse in 85 papers openfermionqchem/_qchem_parser.py ran Apache-2.0 (permissive) · e06d6ed50efaf55a · report fixture: signature output:str/0/str, from_where:int/0/int, letter_type:str/0/str · returned int · level recorded 2026-09-26
periodic_table openfermionqchem/_qchem_parser.py ran fingerprinted Apache-2.0 (permissive) · 34062f6a49554c7e · report fixture: signature proton:int/0/int · returned str · level recorded 2026-09-26
quantumlib/OpenFermion community (archive-listed) 9 samples, 7 ran (0 instrument-failed) · 2 unverified
angstroms_to_bohr src/openfermion/chem/molecular_data.py ran fingerprinted Apache-2.0 (permissive) · fe6beac2afb1b241 · report fixture: signature distance:float/0/float · returned float · level recorded 2026-09-26
bohr_to_angstroms src/openfermion/chem/molecular_data.py ran fingerprinted Apache-2.0 (permissive) · 24fec827df86cb55 · report fixture: signature distance:Tensor/1/float · returned Tensor · level recorded 2026-09-26
lambda_norm src/openfermion/circuits/lcu_util.py ran Apache-2.0 (permissive) · 721d851992e9a94d · report fixture: signature diagonal_operator:DiagonalCoulombHamiltonian/0/? · returned float64 · level recorded 2026-09-26
preprocess_lcu_coefficients_for_reversible_sampling src/openfermion/circuits/lcu_util.py ran Apache-2.0 (permissive) · e84fa36ba99f6dcb · report fixture: signature lcu_coefficients:list/1/float, epsilon:float/0/float · returned tuple · level recorded 2026-09-26
uccsd_convert_amplitude_format src/openfermion/circuits/unitary_cc.py ran Apache-2.0 (permissive) · 3b91d0e5517cd972 · report fixture: signature single_amplitudes:ndarray/2/float, double_amplitudes:ndarray/4/float · returned tuple · level recorded 2026-09-26
uccsd_singlet_paramsize src/openfermion/circuits/unitary_cc.py ran fingerprinted Apache-2.0 (permissive) · 9e7253ceb0973883 · report fixture: signature n_qubits:int/0/int, n_electrons:int/0/int · returned int · level recorded 2026-09-26
wrap_module src/openfermion/_compat.py ran Apache-2.0 (permissive) · d8b172a8142843da · report fixture: signature module:module/0/?, deprecated_attributes:dict/0/? · returned Wrapped · level recorded 2026-09-26
geometry_from_pubchem src/openfermion/chem/pubchem.py unverified Apache-2.0 (permissive) · 2423058f3e5bbbfa · report
name_molecule src/openfermion/chem/molecular_data.py unverified Apache-2.0 (permissive) · 7ef5e44955306241 · report
quantumlib/OpenFermion-ProjectQ community (archive-listed) 3 samples, 3 ran (0 instrument-failed) · 0 unverified
index_of_position_in_1d_array openfermionprojectq/_parallel_bubble_sort.py ran Apache-2.0 (permissive) · f6b4466b04d918d4 · report fixture: signature coordinate_ordering:tuple/1/int, system_side_length:int/0/int, position:tuple/1/int · returned int · level recorded 2026-09-26
is_sorted_array_of_nd_positions openfermionprojectq/_parallel_bubble_sort.py ran Apache-2.0 (permissive) · 6e1651ebdde223f3 · report fixture: signature arr:list/1/list, key:callable/0/?, system_side_length:int/0/int · returned bool · level recorded 2026-09-26
parallel_bubble_sort openfermionprojectq/_parallel_bubble_sort.py ran Apache-2.0 (permissive) · 01ae70a7c6aea6b1 · report fixture: signature array:list/1/tuple, key:callable/0/?, system_side_length:int/0/int · returned list · level recorded 2026-09-26

Results from the paper archive 2025-07-28

No leaderboard rows for this paper in the archive.

Report a problem or propose a change · a person checks every report against the paper or source before anything changes; decisions are listed on /corrections