This repository has been archived by the owner. It is now read-only.
Plugin for OpenFermion which supports circuit compilation using ProjectQ.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


OpenFermion-ProjectQ (Deprecated) Documentation Status

OpenFermion is an open source package for compiling and analyzing quantum algorithms that simulate fermionic systems. This plugin library allows the circuit simulation and compilation package ProjectQ to interface with OpenFermion. However, OpenFermion-ProjectQ is now archived and deprecated since it is NO LONGER MAINTAINED. If you are interested in maintaining the package and qualified to do so, please contact us.

Getting started

Installing OpenFermion-ProjectQ requires pip. Make sure that you are using an up-to-date version of it. Once installation is complete, be sure to take a look at the ipython notebook demo as well as our detailed code documentation.

Developer install

To install the latest versions of OpenFermion, ProjectQ and OpenFermion-ProjectQ (in development mode):

git clone
cd OpenFermion-ProjectQ
python -m pip install -e .

Library install

To install the latest PyPI releases as libraries (in user mode):

python -m pip install --user openfermionprojectq

How to contribute

This package is deprecated and no longer accepting contributions. However, if you are interested in maintaining the package and qualified to do so, please contact us. We would be happy to transfer the repository to responsible owners if there is interest in continuing development.


Ryan Babbush (Google), Jarrod McClean (Google), Ian Kivlichan (Harvard), Kevin J. Sung (University of Michigan), Damian Steiger (ETH Zurich), Dave Bacon (Google), 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), Cupjin Huang (University of Michigan), Josh Izaac (Xanadu), Zhang Jiang (NASA), Xinle Liu (Google), Sam McArdle (Oxford), Matthew Neeley (Google), Thomas O'Brien (Leiden University), Isil Ozfidan (D-Wave Systems), Max Radin (UC Santa Barbara), Jhonathan Romero (Harvard), Nicholas Rubin (Rigetti), Daniel Sank (Google), Nicolas Sawaya (Harvard), Kanav Setia (Dartmouth), Hannah Sim (Harvard), Mark Steudtner (Leiden University), Qiming Sun (Caltech), Wei Sun (Google), Daochen Wang (River Lane Research), Chris Winkler (University of Chicago) and Fang Zhang (University of Michigan).

How to cite

When using OpenFermion-ProjectQ for research projects, please cite:

Jarrod R. McClean, Ian D. Kivlichan, Kevin J. Sung, Damian S. Steiger, Yudong Cao, Chengyu Dai, E. Schuyler Fried, Craig Gidney, Brendan Gimby, Pranav Gokhale, Thomas Häner, Tarini Hardikar, Vojtĕch Havlíček, Cupjin Huang, Josh Izaac, Zhang Jiang, Xinle Liu, Matthew Neeley, Thomas O'Brien, Isil Ozfidan, Maxwell D. Radin, Jhonathan Romero, Nicholas Rubin, Nicolas P. D. Sawaya, Kanav Setia, Sukin Sim, Mark Steudtner, Qiming Sun, Wei Sun, Fang Zhang and Ryan Babbush. OpenFermion: The Electronic Structure Package for Quantum Computers. arXiv:1710.07629. 2017.

as well as

Damian S. Steiger, Thomas Häner and Matthias Troyer. ProjectQ: An Open Source Software Framework for Quantum Computing. arXiv:1612.08091. 2016.

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


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