Open source package for analyzing, compiling and emulating quantum algorithms for simulation of fermions.
Project description
OpenFermion is an open source effort for compiling and analyzing quantum algorithms to simulate fermionic systems, including quantum chemistry. The current version is an alpha release which features data structures and tools for obtaining and manipulating representations of fermionic Hamiltonians.
Getting started
Installing OpenFermion requires pip. Make sure that you are using an up-to-date version of it. To install the latest development version of OpenFermion, clone this git repo, change directory to the top level folder and run:
python -m pip install -e .Alternatively, if using OpenFermion as a library, one can install the last official PyPI release with:
python -m pip install --pre --user openfermionFor further information about how to get started please see intro and code examples. Also take a look at the the ipython notebook demo in the examples folder of this repository as well as our detailed code documentation.
Plugins
In order to simulate and compile quantum circuits or perform other complicated electronic structure calculations, one can install OpenFermion plugins. We currently support a circuit simulation plugin for ProjectQ, which you can find at OpenFermion-ProjectQ. We also support electronic structure plugins for Psi4, which you can find at OpenFermion-Psi4 (recommended), and for PySCF, which you can find at OpenFermion-PySCF.
How to contribute
We’d love to accept your contributions and patches to OpenFermion. There are a few small guidelines you need to follow. Contributions to OpenFermion must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests. Furthermore, please make sure your new code comes with extensive tests! We use automatic testing to make sure all pull requests pass tests and do not decrease overall test coverage by too much. Make sure you adhere to our style guide. Just have a look at our code for clues. We mostly follow PEP 8 and use the corresponding linter to check for it. Code should always come with documentation, which is generated automatically and can be found here.
Questions?
If you have any other questions, please contact help@openfermion.org.
Disclaimer
Copyright 2017 The OpenFermion Developers. This is not an official Google product.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
