FermiLib: Open source software for analyzing fermionic quantum simulation algorithms
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.rst

FermiLib - Open source software for analyzing quantum simulation algorithms

https://travis-ci.org/ProjectQ-Framework/FermiLib.svg?branch=master Documentation Status

FermiLib is an open source effort for compiling and analyzing quantum simulation algorithms.

The current version is an alpha release which features data structures and tools for obtaining and manipulating representations of fermionic Hamiltonians. FermiLib is designed as a library on top of ProjectQ and leverages ProjectQ to compile, emulate and simulate quantum circuits. There are also plugins available for FermiLib.

You may also be interested in OpenFermion, an actively developed FermiLib fork which is designed without an explicit dependency on ProjectQ in order to support a variety of circuit compilation and simulation frameworks.

Getting started

To start using FermiLib, follow the installation instructions in the intro. There, you will also find code examples. Also, make sure to check out the ProjectQ website and the detailed code documentation. Alternatively, consider creating a Docker container defined by the Dockerfile found inside the docker directory. Moreover, take a look at the available plugins for FermiLib.

Plugins

In order to generate molecular hamiltonians in Gaussian basis sets and perform other complicated electronic structure calculations, one can install plugins. We currently support Psi4 (plugin here, recommended) and PySCF (plugin here).

How to contribute

To contribute code please adhere to the following very simple rules:

  1. Make sure your new code comes with extensive tests!
  2. Make sure you adhere to our style guide. Until we release a code style guide, just have a look at our code for clues. We mostly follow pep8 and use the pep8 linter to check for it.
  3. Put global constants and configuration parameters into src/fermilib/config.py, and add from config import * in the file that uses the constants/parameters.

Documentation can be found here.

Authors

The first release of FermiLib (v0.1a0) was developed by Ryan Babbush, Jarrod McClean, Damian S. Steiger, Ian D. Kivlichan, Thomas Häner, Vojtech Havlicek, Matthew Neeley, and Wei Sun.

How to cite

When using FermiLib for research projects, please cite:

Jarrod R. McClean, Ian D. Kivlichan, Kevin J. Sung, Damian S. Steiger, Yudong Cao, Chengyu Dai, E. Schuyler Fried, Craig Gidney, Brendan Gimby, Thomas Häner, Tarini Hardikar, Vojtĕch Havlíček, Cupjin Huang, Zhang Jiang, Matthew Neeley, Thomas O'Brien, Isil Ozfidan, Maxwell D. Radin, Jhonathan Romero, Nicholas Rubin, Nicolas P. D. Sawaya, Kanav Setia, Sukin Sim, Mark Steudtner, Wei Sun, Fang Zhang and Ryan Babbush. OpenFermion: The Electronic Structure Package for Quantum Computers. arXiv:1710.07629. 2017.

Questions?

If you have any other questions, please contact fermilib@projectq.ch.

License

FermiLib is released under the Apache 2 license.