Skip to content

Commit 63c1392

Browse files
authored
updated readme (#9)
1 parent 28848b7 commit 63c1392

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,30 @@ OpenFermion-PySCF
44
.. image:: https://badge.fury.io/py/openfermionpyscf.svg
55
:target: https://badge.fury.io/py/openfermionpyscf
66

7+
.. image:: https://img.shields.io/badge/python-2.7%2C%203.4%2C%203.5%2C%203.6-brightgreen.svg
8+
79
`OpenFermion <http://openfermion.org>`__ is an open source library (licensed under Apache 2) for compiling and analyzing quantum algorithms which simulate fermionic systems.
810
This plugin library allows the electronic structure package `PySCF <http://github.com/sunqm/pyscf>`__ (licensed under BSD-2-Clause) to interface with OpenFermion.
911

1012
Installation
1113
------------
1214

13-
To install the latest development versions of OpenFermion, PySCF and OpenFermion-PySCF,
14-
clone `this <http://github.com/quantumlib/OpenFermion-PySCF>`__ git repo, change directory to the top level folder and run:
15+
To install the latest versions of OpenFermion, PySCF and OpenFermion-PySCF in development mode:
1516

1617
.. code-block:: bash
1718
19+
git clone https://github.com/quantumlib/OpenFermion-PySCF
20+
cd OpenFermion-PySCF
1821
python -m pip install -e .
1922
20-
Alternatively, if using OpenFermion-PySCF as a library, one can install the last official PyPI release with:
23+
Alternatively, to install the latest PyPI releases as libraries (in user mode):
2124

2225
.. code-block:: bash
2326
2427
python -m pip install --pre --user openfermionpyscf
2528
26-
Also be sure to take a look at the ipython notebook demos in the examples folder of this repository.
29+
Also be sure to take a look at the `ipython notebook demo <https://github.com/quantumlib/OpenFermion-PySCF/blob/master/examples/openfermionpyscf_demo.ipynb>`__
30+
in the examples folder of this repository.
2731

2832
How to contribute
2933
-----------------
@@ -54,9 +58,9 @@ Authors
5458
`Ryan Babbush <http://ryanbabbush.com>`__ (Google),
5559
`Jarrod McClean <http://jarrodmcclean.com>`__ (Google),
5660
`Ian Kivlichan <http://aspuru.chem.harvard.edu/ian-kivlichan/>`__ (Harvard),
57-
Damian Steiger (ETH Zurich),
58-
Thomas Haener (ETH Zurich) and
59-
Dave Bacon (Google)
61+
`Damian Steiger <https://github.com/damiansteiger>`__ (ETH Zurich),
62+
`Thomas Haener <https://github.com/thomashaener>`__ (ETH Zurich) and
63+
`Dave Bacon <https://github.com/dabacon>`__ (Google).
6064

6165
Disclaimer
6266
----------

0 commit comments

Comments
 (0)