Skip to content

Commit 31cf9c1

Browse files
committed
README.md and documentation updated
1 parent 795f71a commit 31cf9c1

File tree

3 files changed

+38
-1
lines changed

3 files changed

+38
-1
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
11
# graphflow : Algorithms for Graph Flow Analysis
2+
3+
This Python package provides numerical routines for graph flow analysis, particularly:
4+
5+
* PageRank
6+
* Linear System of Resistance
7+
* Non-linear System of Resistance
8+
9+
# Installation
10+
11+
You must have `numpy` pre-installed. GCC and GFORTRAN compilers have to be available in the machine.
12+
After ensuring they have been installed, type the following to install `graphflow`:
13+
14+
```
15+
>>> pip install -U graphflow
16+
```
17+
18+
# News
19+
20+
* 06/06/2018: `graphflow` 0.1.2 released.
21+
* 04/12/2018: `graphflow` 0.1.1 released.

doc/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ Welcome to GraphFlow's documentation!
99
Contents:
1010

1111
.. toctree::
12-
:maxdepth: 2
12+
:maxdepth: 1
1313

14+
intro
1415
news
1516

1617
Indices and tables

doc/source/intro.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Introduction to graphflow
2+
=========================
3+
4+
This Python package provides numerical routines for graph flow analysis, particularly:
5+
6+
* PageRank
7+
* Linear System of Resistance
8+
* Non-linear System of Resistance
9+
10+
Author: Kwan-Yuet Ho (LinkedIn_, ResearchGate_, Twitter_)
11+
12+
Home: :doc:`index`
13+
14+
.. _LinkedIn: https://www.linkedin.com/in/kwan-yuet-ho-19882530
15+
.. _ResearchGate: https://www.researchgate.net/profile/Kwan-yuet_Ho
16+
.. _Twitter: https://twitter.com/stephenhky

0 commit comments

Comments
 (0)