Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 238513d

Browse files
authored
Docs update (#57)
* removed redudant part of readme * docs fix
1 parent cd9a0c9 commit 238513d

3 files changed

Lines changed: 4 additions & 6 deletions

File tree

README.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@ OpenFermion
1717

1818
.. image:: https://img.shields.io/badge/python-2.7%2C%203.4%2C%203.5%2C%203.6-brightgreen.svg
1919

20-
OpenFermion is an open source effort for compiling and analyzing quantum algorithms to simulate fermionic systems, including quantum chemistry. The current version is an alpha release which features data structures and tools for obtaining and manipulating representations of fermionic Hamiltonians. For other information about how to get started please see `intro <http://openfermion.readthedocs.io/en/latest/intro.html>`__ and `code examples <http://openfermion.readthedocs.io/en/latest/examples.html>`__. Also take a look at the
21-
`ipython notebook demo <https://github.com/quantumlib/OpenFermion/blob/master/examples/openfermion_demo.ipynb>`__
22-
as well as our detailed `code documentation <http://openfermion.readthedocs.io/en/latest/openfermion.html>`__.
20+
OpenFermion is an open source effort for compiling and analyzing quantum algorithms to simulate fermionic systems, including quantum chemistry. The current version is an alpha release which features data structures and tools for obtaining and manipulating representations of fermionic Hamiltonians.
2321

2422
Getting started
2523
===============

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Welcome to the docs
66
Contents
77
* :ref:`intro`: Introduction & Installation
88
* :ref:`examples`: Code examples
9-
* :ref:`codedoc`: The code documentation of openfermion.
9+
* :ref:`codedoc`: The code documentation of OpenFermion.
1010

1111
.. toctree::
1212
:maxdepth: 2

docs/intro.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Tutorial
77
:maxdepth: 2
88

99
Getting started with OpenFermion
10-
-----------------------------
10+
--------------------------------
1111

1212
Installing OpenFermion requires pip. Make sure that you are using an up-to-date
1313
version of it by running:
@@ -34,7 +34,7 @@ For further information about how to get started please see `intro <http://openf
3434

3535

3636
Basic OpenFermion example
37-
----------------------
37+
-------------------------
3838

3939
To see a basic example with both fermion and qubit operators as well as whether the installation worked, try to run the following code.
4040

0 commit comments

Comments
 (0)