README.md

The Rigetti Forest Plugin for OpenFermion

OpenFermion is an open source package for compiling and analyzing quantum algorithms that simulate fermionic systems. This plugin library allows the circuit construction and simulation environment Forest to interface with OpenFermion.

Getting Started

Before installing forestopenfermion using pip, you must first have cython installed:

pip install cython

Then, to install from source, run the following from inside the top-level directory:

pip install -e .

Alternatively, one can install the last major release from PyPI via:

pip install forestopenfermion

Development and Testing

We use pytest for testing. Tests can be executed from the top-level directory by simply running:

pytest

Note that you will need to have installed the requirements via pip install -r requirements.txt to get pytest.