Louvain Community Detection
===========================

Installing
----------

To build and install run::

     python setup.py install

Usage
-----

To use from the command line::

     $ community <filename>

filename is a binary file as generated by the
convert utility distributed with the C implementation

To use as a python library::

     import community

Documentation
-------------

To generate documentation run::

     pip install numpydoc sphinx
     cd docs
     make

Tests
-----

To run tests::

     pip install nose
     python setup.py test