A plugin allowing OpenFermion to interface with PySCF.
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 PySCF (licensed under BSD-2-Clause) to interface with OpenFermion.
Installation
To install the latest versions of OpenFermion, PySCF and OpenFermion-PySCF (in development mode):
git clone https://github.com/quantumlib/OpenFermion-PySCF
cd OpenFermion-PySCF
python -m pip install -e .
Alternatively, to install the latest PyPI releases as libraries (in user mode):
python -m pip install --pre --user openfermionpyscf
Also 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-PySCF. There are a few guidelines you need to follow. Contributions to OpenFermion-PySCF 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.
Project details
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.
Source Distribution
File details
Details for the file openfermionpyscf-0.1a2.tar.gz
.
File metadata
- Download URL: openfermionpyscf-0.1a2.tar.gz
- Upload date:
- Size: 8.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cdd3087d0446b9ae701f7c874a0835a1d776dd37bdc42b708c81feb699874ccd |
|
MD5 | ef792686001e781f61fe786981a75f8a |
|
BLAKE2b-256 | dc99326cdb650cbaee922ffcfb5b06e22d8811e269500945107e4918701d9c6f |