Skip to main content

A plugin allowing OpenFermion to interface with Forest.

Project description

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.


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

forestopenfermion-0.0.2.tar.gz (4.6 kB view hashes)

Uploaded Source

Built Distribution

forestopenfermion-0.0.2-py2-none-any.whl (8.5 kB view hashes)

Uploaded Python 2

Supported by

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