@@ -10,19 +10,19 @@ This plugin library allows the electronic structure package `Psi4 <http://psicod
10
10
Installation
11
11
------------
12
12
13
- To start using OpenFermion-Psi4, first install `OpenFermion <http://openfermion .org >`__ and
14
- ` Psi4 < http://psicode.org >`__. Note that the Psi4 package is designed specifically for the
15
- `Anaconda python distribution. <https://www.anaconda.com/download >`__
13
+ To start using OpenFermion-Psi4, first install `Psi4 <http://psicode .org >`__.
14
+ Note that Psi4 is designed specifically for the
15
+ `Anaconda <https://www.anaconda.com/download >`__ python distribution.
16
16
While it is possible to install Psi4 without Anaconda, if one does use Anaconda python
17
- the following commands will install Psi4 and pip (needed to install OpenFermion):
17
+ the following commands will install Psi4 and pip (used to install OpenFermion-Psi4 ):
18
18
19
19
.. code-block :: bash
20
20
21
21
conda config --add channels http://conda.anaconda.org/psi4
22
22
python -m conda install psi4
23
23
python -m conda install pip
24
24
25
- Once OpenFermion and Psi4 have been installed, to install the latest development version of OpenFermion-Psi4,
25
+ Once Psi4 has been installed, to install the latest development versions of OpenFermion and OpenFermion-Psi4,
26
26
clone `this <http://github.com/quantumlib/OpenFermion-Psi4 >`__ git repo,
27
27
change directory to the top level folder and run:
28
28
@@ -42,7 +42,7 @@ How to contribute
42
42
-----------------
43
43
44
44
We'd love to accept your contributions and patches to OpenFermion-Psi4.
45
- There are a few small guidelines you need to follow.
45
+ There are a few guidelines you need to follow.
46
46
Contributions to OpenFermion-Psi4 must be accompanied by a Contributor License Agreement.
47
47
You (or your employer) retain the copyright to your contribution,
48
48
this simply gives us permission to use and redistribute your contributions as part of the project.
@@ -59,8 +59,7 @@ decrease overall test coverage by too much. Make sure you adhere to our style
59
59
guide. Just have a look at our code for clues. We mostly follow
60
60
`PEP 8 <https://www.python.org/dev/peps/pep-0008/ >`_ and use
61
61
the corresponding `linter <https://pypi.python.org/pypi/pep8 >`_ to check for it.
62
- Code should always come with documentation, which is generated automatically and can be found
63
- `here <http://openfermion.readthedocs.io/en/latest/openfermion.html >`_.
62
+ Code should always come with documentation.
64
63
65
64
Authors
66
65
-------
0 commit comments