Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rigetti/forest-openfermion
OpenFermion quantum chemistry plugin for @rigetti Forest.
https://github.com/rigetti/forest-openfermion
forest openfermion quantum-chemistry quantum-computing
Last synced: 3 months ago
JSON representation
OpenFermion quantum chemistry plugin for @rigetti Forest.
- Host: GitHub
- URL: https://github.com/rigetti/forest-openfermion
- Owner: rigetti
- License: apache-2.0
- Created: 2017-10-19T17:30:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-11-30T15:12:58.000Z (about 3 years ago)
- Last Synced: 2024-05-17T12:48:21.319Z (8 months ago)
- Topics: forest, openfermion, quantum-chemistry, quantum-computing
- Language: Python
- Homepage:
- Size: 73.2 KB
- Stars: 71
- Watchers: 12
- Forks: 25
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
The Rigetti Forest Plugin for OpenFermion
=========================================
[![Build Status][semaphore-badge]][semaphore-project]
[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 environment [Forest](http://www.rigetti.com/forest) to
interface with OpenFermion.
Getting Started
---------------
Before installing `forestopenfermion` using `pip`, you must first have `cython` installed:
```bash
pip install cython
```
Then, to install from source, run the following from inside the top-level directory:
```bash
pip install -e .
```
Alternatively, one can install the last major release from PyPI via:
```bash
pip install forestopenfermion
```
Development and Testing
-----------------------
We use `pytest` for testing. Tests can be executed from the top-level directory by simply running:
```bash
pytest
```
Note that you will need to have installed the requirements via `pip install -r requirements.txt`
to get `pytest`.
[semaphore-badge]: https://semaphoreci.com/api/v1/rigetti/forest-openfermion/branches/master/shields_badge.svg
[semaphore-project]: https://semaphoreci.com/rigetti/forest-openfermion