== KONECT Toolbox ==

This is a toolbox for the analysis of large complex networks written in
Matlab, but also largely compatible with GNU Octave.  It is used by the KONECT
Project:

http://konect.cc/

This toolbox largely implements the graph analysis functions described in 
the KONECT Handbook: 

https://github.com/kunegis/konect-handbook/blob/master/konect-handbook.pdf

In particular, the KONECT Handbook contains all formal definitions of
the computations performed in this toolbox.

To support KONECT, you may donate here:

https://www.paypal.com/donate?hosted_button_id=Q9JY2FB3AFHR6

=== Installation ===

The toolbox consists entirely of *.m files.  To use it, add the
directory m/ to the Matlab path, e.g., using addpath() or by setting the
$MATLABPATH variable.

GNU Octave too supports the addpath() function and $MATLABPATH
variable. 

=== Requirements ===

Some functions need Matlab-BGL, the Matlab port of the Boost Graph
Library.    

Installation of Matlab-BGL:
* Download version 4.0.1 from the Matlab-BGL website (newer versions may
  not work) 
* Unzip it somewhere where you'll keep it
* (On a few old Debian-based systems, we needed to install libstdc++5 from http://packages.debian.org/stable/base/libstdc++5) 
* Make sure matlab_bgl/ is the the Matlab path.  This is necessary for
  both GNU Octave and Matlab.  For instance, do
	export MATLABPATH="$MATLABPATH:~/matlab_bgl/"
  (But probably you have your own way of setting the Matlab path.)

=== Usage ===

The toolbox consists of individual functions, each of which is
contained in its own *.m file in the m/ directory.  

Most functions are self-contained, and can be used as-is. 

Each function is documented in its source file.  

The source files contain UTF-8 encoded text in the comments; the rest is
ASCII.  

The functions are used from both GNU Octave Matlab and Matlab.  Since none of
these is properly standardised, we can't assure that all versions will
work -- when in doubt, ask. 

If you fix bugs or add new features, please contact <konectproject@outlook.com>
so we can merge your changes into the master version.

=== Help ===

For support, write to <konectproject@outlook.com>, or directly write a ticket on
GitHub:  

https://github.com/kunegis/konect-toolbox

=== License ===

Written by Jérôme Kunegis.

The KONECT Toolbox is free software, and therefore you can easily use it
in your project.  You can either tell your users that they have to
install the KONECT Toolbox before they use your software, or you can put
a copy of the files you need into your project directory.  If you copy
files from the KONECT Toolbox into your project directory, make sure you
follow the GNU GPL:  Write in your README file which files are from the
KONECT Toolbox, mention this license information, and provide a copy of
the GNU GPL, i.e., the file COPYING. 

The KONECT Toolbox is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as published
by the Free Software Foundation, either version 3 of the License, or (at
your option) any later version. 

The KONECT Toolbox 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.  See the GNU
General Public License for more details. 

The full text of the GPLv3 can be found in the file COPYING.