Metadata-Version: 2.0
Name: forestopenfermion
Version: 0.0.2
Summary: A plugin allowing OpenFermion to interface with Forest.
Home-page: UNKNOWN
Author: Rigetti Computing
Author-email: softapps@rigetti.com
License: Apache 2
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Requires-Dist: scipy (>=0.18.0)
Requires-Dist: numpy (>=1.11.0)
Requires-Dist: openfermion (==0.1a0)
Requires-Dist: pyquil (>=1.1.0)
Requires-Dist: future

Forest-OpenFermion
==================

[![Build Status](https://semaphoreci.com/api/v1/projects/804e75d3-73d1-4529-b65f-b80d390f2782/1579863/badge.svg)] (https://semaphoreci.com/rigetti/forestopenfermion)

`OpenFermion <http://openfermion.org>`_ 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 <http://www.rigetti.com/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:

.. code-block:: bash

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

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

.. code-block:: bash

  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:

.. code-block:: bash
  tox

The setup is currently testing Python 2.7 and Python 3.6.


