Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
somacdivad committed Dec 4, 2017
1 parent 340688b commit 91383ba
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions README.md
Expand Up @@ -4,21 +4,46 @@
*A NetworkX extension for calculating graph invariants.*

### What is it?
GrinPy is still in development. We are working hard to finish the first release. Our aim is to create an easy-to-use extension of NetworkX for computing all kinds of graph invariants.
GrinPy is still in development. We have released version 0.1.0 which includes
several well-known graph invariants. However, the algorithms used to calculate
NP-hard invariants are simple brute force. We will be updating these to more
efficient algorithms over the next several months in our build-up to version
1.0.

NP-hard invariants in version 0.1 include:

* Independence number
* *k*-Independence number
* Domination number
* *k*-Domination number
* Zero forcing number
* *k*-Forcing number

Other invariants included are:

* Residue
* *k*-Residue
* Slater number
* Sub-*k*-domination number
* Annihilation number

### How do I use it?
Full documentation will be released soon. For now, here's a sample:
Full documentation is available at [https://grinpy.rtfd.io](https://grinpy.rtfd.io). Here is a sample of how to
calculate the independence number:
```python
>>> import grinpy as gp
>>> G = gp.petersen_graph()
>>> gp.independence_number(G)
4
```

GrinPy automatically imports NetworkX and provides all of the NetworkX classes and methods in the same interface.
GrinPy automatically imports [NetworkX](https://github.com/networkx/networkx) and provides all of the NetworkX classes and methods in the same interface.

### Why does it exist?
The motivation for this project is to filter a database of graphs into an ordered tree of subsets. The graphs in this database are relatively small (no more than 16 - 20 vertices) and thus, in the interest of quickly creating our database, we have written brute force algorithms for finding many of the NP-hard invariants. After the first release we will work on improving our algorithms.
The motivation for this project is to filter a database of graphs into an ordered tree of subsets. This database will be used in an experimental automated
conjecturing program. In creating the required packages for this database, we
realized that a Python package for calculating graph invariants would be
useful for professional research and for graph theory education.

### License
Released under the 3-Clause BSD license (see `LICENSE.txt`):
Expand Down

0 comments on commit 91383ba

Please sign in to comment.