Skip to main content

The electronic structure package for quantum computers.

Project description

OpenFermion logo

Compatible with Python versions 3.10 and higher Licensed under the Apache 2.0 license OpenFermion project on PyPI OpenFermion downloads per month from PyPI

Blank space OpenFermion is an open-source library for compiling and analyzing quantum algorithms to simulate fermionic systems, including quantum chemistry. Among other features, it includes data structures and tools for obtaining and manipulating representations of fermionic and qubit Hamiltonians. For more information, see our release paper.

You can run the interactive Jupyter Notebooks in Colab or MyBinder.

Installation and Documentation

Installing the latest stable OpenFermion requires the Python package installer pip. Make sure that you are using an up-to-date version of it.

Documentation can be found at quantumai.google/openfermion and the following links:

Currently, OpenFermion is tested on Mac, Windows, and Linux. We recommend using Mac or Linux because the electronic structure plugins are only compatible on these platforms. However, for those who would like to use Windows, or for anyone having other difficulties with installing OpenFermion or its plugins, we provide a Docker image and usage instructions in the docker folder. The Docker image provides a virtual environment with OpenFermion and select plugins pre-installed. The Docker installation should run on any operating system where Docker can be used.

Developer install

To install the latest version of OpenFermion (in development mode), run the following commands:

git clone https://github.com/quantumlib/OpenFermion
cd OpenFermion
python -m pip install -e .

Library install

To install the latest PyPI release as a library (in user mode), run the following commands:

python -m pip install --user openfermion

Plugins

OpenFermion relies on modular plugin libraries for significant functionality. Specifically, plugins are used to simulate and compile quantum circuits and to perform classical electronic structure calculations. Follow the links below to learn more!

High-performance simulators

  • OpenFermion-FQE is a high-performance emulator of fermionic quantum evolutions specified by a sequence of fermion operators, which can exploit fermionic symmetries such as spin and particle number.

Circuit compilation plugins

Electronic structure package plugins

How to contribute

We’d love to accept your contributions and patches to OpenFermion. There are a few small guidelines you need to follow. Contributions to OpenFermion must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution; the CLA this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests. Furthermore, please make sure your new code comes with extensive tests! We use automatic testing to make sure all pull requests pass tests and do not decrease overall test coverage by too much. Make sure you adhere to our style guide. Just have a look at our code for clues. We mostly follow PEP 8 and use the corresponding linter to check for it. Code should always come with documentation, which is generated automatically and can be found here.

We use Github issues for tracking requests and bugs. Please post questions to the Quantum Computing Stack Exchange with an ‘openfermion’ tag.

Authors

Ryan Babbush (Google), Jarrod McClean (Google), Nicholas Rubin (Google), Kevin Sung (University of Michigan), Ian Kivlichan (Harvard), Dave Bacon (Google), Xavier Bonet-Monroig (Leiden University), Yudong Cao (Harvard), Chengyu Dai (University of Michigan), E. Schuyler Fried (Harvard), Craig Gidney (Google), Brendan Gimby (University of Michigan), Pranav Gokhale (University of Chicago), Thomas Häner (ETH Zurich), Tarini Hardikar (Dartmouth), Vojtĕch Havlíček (Oxford), Oscar Higgott (University College London), Cupjin Huang (University of Michigan), Josh Izaac (Xanadu), Zhang Jiang (NASA), William Kirby (Tufts University), Xinle Liu (Google), Sam McArdle (Oxford), Matthew Neeley (Google), Thomas O’Brien (Leiden University), Bryan O’Gorman (UC Berkeley, NASA), Isil Ozfidan (D-Wave Systems), Max Radin (UC Santa Barbara), Jhonathan Romero (Harvard), Daniel Sank (Google), Nicolas Sawaya (Harvard), Bruno Senjean (Leiden University), Kanav Setia (Dartmouth), Hannah Sim (Harvard), Damian Steiger (ETH Zurich), Mark Steudtner (Leiden University), Qiming Sun (Caltech), Wei Sun (Google), Daochen Wang (River Lane Research), Chris Winkler (University of Chicago), Fang Zhang (University of Michigan) and Emiel Koridon (Leiden University).

How to cite

When using OpenFermion for research projects, please cite:

Jarrod R McClean, Nicholas C Rubin, Kevin J Sung, Ian D Kivlichan, Xavier Bonet-Monroig, 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, Nicolas P D Sawaya, Bruno Senjean, Kanav Setia, Sukin Sim, Damian S Steiger, Mark Steudtner, Qiming Sun, Wei Sun, Daochen Wang, Fang Zhang, and Ryan Babbush OpenFermion: The Electronic Structure Package for Quantum Computers. Quantum Science and Technology 5.3 (2020): 034014.

We are happy to include future contributors as authors on later releases.

Disclaimer

Copyright 2017 The OpenFermion Developers. This is not an official Google product.

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

openfermion-1.7.1.tar.gz (44.5 MB view details)

Uploaded Source

Built Distribution

openfermion-1.7.1-py3-none-any.whl (44.7 MB view details)

Uploaded Python 3

File details

Details for the file openfermion-1.7.1.tar.gz.

File metadata

  • Download URL: openfermion-1.7.1.tar.gz
  • Upload date:
  • Size: 44.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.0

File hashes

Hashes for openfermion-1.7.1.tar.gz
Algorithm Hash digest
SHA256 717f4b969a1fd1df24f11bd462b485d317f257bdd91cef32ced23d276cc83f70
MD5 4499dd81e7db4899a695f200f961d35c
BLAKE2b-256 10865ab524a132b93e70c55215dfb91d2ce8012801a82f55ad6643616717575b

See more details on using hashes here.

File details

Details for the file openfermion-1.7.1-py3-none-any.whl.

File metadata

  • Download URL: openfermion-1.7.1-py3-none-any.whl
  • Upload date:
  • Size: 44.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.0

File hashes

Hashes for openfermion-1.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2f3745786d9aa1913bb3281b5151eae3a5082d90aeacd6b964e813b9fa8a3e46
MD5 83833e74cc3d6a6efc650108854b354e
BLAKE2b-256 b43928f89ae6516fe327e22ea2f8162c0f83f6d580a8ca00a47447b4473571e3

See more details on using hashes here.

Supported by

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