Skip to content

Commit 93262d8

Browse files
authored
Readme (#19)
* changing looks of readme * reordering * added links to pep8
1 parent de50700 commit 93262d8

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

README.rst

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -40,30 +40,11 @@ Plugins
4040

4141
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 <https://projectq.ch>`__, which you can find at `OpenFermion-ProjectQ <http://github.com/quantumlib/OpenFermion-ProjectQ>`__. We also support electronic structure plugins for `Psi4 <http://psicode.org>`__, which you can find at `OpenFermion-Psi4 <http://github.com/quantumlib/OpenFermion-Psi4>`__ (recommended), and for `PySCF <https://github.com/sunqm/pyscf>`__, which you can find at `OpenFermion-PySCF <http://github.com/quantumlib/OpenFermion-PySCF>`__.
4242

43-
Authors
44-
-------
45-
46-
`Ryan Babbush <http://ryanbabbush.com>`__ (Google),
47-
`Jarrod McClean <http://jarrodmcclean.com>`__ (Google),
48-
`Ian Kivlichan <http://aspuru.chem.harvard.edu/ian-kivlichan/>`__ (Harvard),
49-
Damian Steiger (ETH Zurich),
50-
Wei Sun (Google),
51-
Craig Gidney (Google),
52-
Thomas Haner (ETH Zurich),
53-
Hannah Sim (Harvard),
54-
Vojtech Havlicek (Oxford),
55-
Kanav Setia (Dartmouth),
56-
Nicholas Rubin (Rigetti),
57-
Matthew Neeley (Google) and
58-
Dave Bacon (Google).
59-
60-
6143
How to contribute
6244
-----------------
6345

6446
We'd love to accept your contributions and patches to OpenFermion.
65-
There are a few small guidelines you need to follow.
66-
47+
There are a few small guidelines you need to follow.
6748
Contributions to OpenFermion must be accompanied by a Contributor License Agreement.
6849
You (or your employer) retain the copyright to your contribution,
6950
this simply gives us permission to use and redistribute your contributions as part of the project.
@@ -77,11 +58,29 @@ more information on using pull requests.
7758
Furthermore, please make sure your new code comes with extensive tests!
7859
We use automatic testing to make sure all pull requests pass tests and do not
7960
decrease overall test coverage by too much. Make sure you adhere to our style
80-
guide. Just have a look at our code for clues. We mostly follow pep8 and use
81-
the pep8 linter to check for it. Code should always come with documentation,
82-
which is generated automatically and can be found
61+
guide. Just have a look at our code for clues. We mostly follow
62+
`PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_ and use
63+
the corresponding `linter <https://pypi.python.org/pypi/pep8>`_ to check for it.
64+
Code should always come with documentation, which is generated automatically and can be found
8365
`here <http://openfermion.readthedocs.io/en/latest/openfermion.html>`_.
8466

67+
Authors
68+
-------
69+
70+
`Ryan Babbush <http://ryanbabbush.com>`__ (Google),
71+
`Jarrod McClean <http://jarrodmcclean.com>`__ (Google),
72+
`Ian Kivlichan <http://aspuru.chem.harvard.edu/ian-kivlichan/>`__ (Harvard),
73+
Damian Steiger (ETH Zurich),
74+
Wei Sun (Google),
75+
Craig Gidney (Google),
76+
Thomas Haner (ETH Zurich),
77+
Hannah Sim (Harvard),
78+
Vojtech Havlicek (Oxford),
79+
Kanav Setia (Dartmouth),
80+
Nicholas Rubin (Rigetti),
81+
Matthew Neeley (Google) and
82+
Dave Bacon (Google).
83+
8584
Questions?
8685
----------
8786

0 commit comments

Comments
 (0)