README.md 2.45 KB
Newer Older
Tiago Peixoto's avatar
Tiago Peixoto committed
1
graph-tool -- an efficient python module for analysis of graphs
2 3 4 5
================================================================

graph-tool is an efficient python module for manipulation and
statistical analysis of graphs. It contains several general graph
Tiago Peixoto's avatar
Tiago Peixoto committed
6
measurements, data structures and algorithms, such as vertex and edge
7
properties, online graph filtering, nearest neighbor statistics,
Tiago Peixoto's avatar
Tiago Peixoto committed
8 9
clustering, interactive graph layout, random graph generation, detection
of community structure, and more.
10 11 12 13 14 15 16 17 18 19 20 21 22

Contrary to most other python modules with similar functionality, the
core data structures and algorithms are implemented in C++, making
extensive use of template metaprogramming, based heavily on the Boost
Graph Library. This confers it a level of performance that is
comparable (both in memory usage and computation time) to that of a
pure C/C++ library.

For more information and documentation, please take a look at the
website http://graph-tool.skewed.de.

graph-tool is free software, you can redistribute it and/or modify it
under the terms of the GNU General Public License, version 3 or
Tiago Peixoto's avatar
Tiago Peixoto committed
23
above. See LICENSE for details.
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Availability
------------

The current stable version of graph-tool is always available from the
project's website: http://graph-tool.skewed.de

Installation
------------

graph-tool follows the standard GNU installation procedure.  Please
consult the INSTALL file in this distribution for more detailed
instructions.

42
Note that recent versions of GCC (5 or above) or clang, with good
43
C++14 support, are required for compilation. Due to the heavy use of
Tiago Peixoto's avatar
Tiago Peixoto committed
44 45
template metaprogramming techniques, **relatively large amounts of RAM
are required during compilation**. You have been warned!  For this
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
reason, pre-compiled packages are available in the website.

More information about graph-tool
---------------------------------

The project homepage is http://graph-tool.skewed.de. It contains
documentation, info on mailing lists, as well as a bug-tracking
function. You should be reading it, instead of this. :-)

Reporting Bugs
--------------

A list of known bugs can be found in the website:

http://graph-tool.skewed.de/issues

If you found a bug in the program which is not included in this list,
please submit a ticket through the provided interface.

--
Tiago Peixoto's avatar
Tiago Peixoto committed
66
Tiago de Paula Peixoto <tiago@skewed.de>