A plugin allowing OpenFermion to interface with Psi4.
Project description
OpenFermion is an open source library (licensed under Apache 2) for compiling and analyzing quantum algorithms which simulate fermionic systems. This plugin library allows the electronic structure package Psi4 (licensed under GNU Lesser General Public License version 3) to interface with OpenFermion.
Installation
To start using OpenFermion-Psi4, first install Psi4. Note that Psi4 is designed specifically for the Anaconda python distribution. While it is possible to install Psi4 without Anaconda, if one does use Anaconda python the following commands will install Psi4 and pip (used to install OpenFermion-Psi4):
conda config --add channels http://conda.anaconda.org/psi4
python -m conda install psi4
python -m conda install pipTo install the latest versions of OpenFermion and OpenFermion-Psi4 (in development mode):
git clone https://github.com/quantumlib/OpenFermion-Psi4
cd OpenFermion-Psi4
python -m pip install -e .Alternatively, to install the latest PyPI releases as libraries (in user mode):
python -m pip install --pre --user openfermionpsi4Also be sure to take a look at the ipython notebook demo.
How to contribute
We’d love to accept your contributions and patches to OpenFermion-Psi4. There are a few guidelines you need to follow. Contributions to OpenFermion-Psi4 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.
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.
