A library for interfacing OpenFermion with Forest.
Switch branches/tags
Clone or download
Latest commit 531bb08 Jun 22, 2018

README.rst

Forest-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 enviornment Forest to interface with OpenFermion.

Getting started

Forest-OpenFermion can be installed from source or as a library using pip.

To install the source, clone this git repo, change directory to the top level folder and run:

pip install -r requirements.txt
python -m pip install -e .

Alternatively, one can install the last major release with the command

python -m pip install forestopenfermion

Development and Testing

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

The setup is currently testing Python 2.7 and Python 3.6.