We support three ways to install NetworKit:
With NetworKit as a Python extension module, you get access to native high-performance code and can at the same time work interactively in the Python ecosystem. Although the standard Python interpreter works fine, we recommend IPython as a great environment for scientific workflows. View the IPython Quickstart Guide for installation instructions and how to use NetworKit with IPython.
Once you have installed NetworKit, please make sure to check out our NetworKit UserGuide for an overview of the features provided in NetworKit.
If you want a quick and easy way to try NetworKit for your purposes or you use a Microsoft Windows operating system, we strongly recommend the installation of our NetworKit virtual machine that can be downloaded here.
Take a look at our installation guide for further instructions on installing the virtual machine on your system.
pip3 install [--user] networkit
Depending on your system, you might need to install python3-tk.
You can remove NetworKit completely by using the command
pip3 uninstall networkit.
To check that everything works as expected, open a python terminal and run the following lines:
import networkit G = networkit.Graph(5) G.addEdge(0,1) G.toString()
You will need the following software to install NetworKit as a python package:
You will need the following software to install NetworKit as a Python package:
This section describes how to build NetworKit including the Python functionality. If you do not wish to install NetworKit as a Python package, please refer to Building Only the C++ Core.
After all requirements are installed, switch to the top folder of NetworKit and run the script setup.py with the following options:
python3 setup.py build_ext --inplace [--optimize=V] [-jX]
The script will call SCons to compile NetworKit as a library and then build the extensions in the folder src/python. By default, NetworKit will be built with
the amount of available cores in optimized mode. It is possible to add the options
-jN the same way it can be done to a manual
SCons call, to specify the optimization level and the number of threads used for compilation. The setup script provides more functionality and can be used with
pip3 install -e ./
will compile NetworKit, build the extensions and on top of that temporarily install NetworKit so that it is available on the whole system. This can be undone by
pip3 uninstall networkit.
python3 setup.py clean [--optimize=V]
will remove the extensions and its build folder as well as call SCons to remove the NetworKit library and its build folder specified by
Note: All of the above installation command may require root privileges depending on your system, so try this accordingly. If you do not have root privileges,
--user to your command.
In case you do not need NetworKit’s Python functionality, this section describes how to build the C++ parts only.
We recommend SCons for building the C++ part of NetworKit. Individual settings for your environment will be read from a configuration file. As an example, the file build.conf.example is provided. Copy this to build.conf and edit your environment settings. Then call Scons.
The call to SCons has the following options:
scons --optimize=<level> --target=<target>
<level> can be
target can be
Corebuild NetworKit as a library, required for the Python extenstion through Cython.
Testsbuild executable for the unit tests (requires GoogleTest).
Libbuild NetworKit as a library and create symbolic links.
For example, to build NetworKit as an optimized library, run
scons --optimize=Opt --target=Lib
To speed up the compilation on a multicore machine, you can append
-jX where X denotes the number of threads to compile with.
Logging is enabled by default. If you want to disable logging functionality, add the following to your scons call:
It is also possible to use NetworKit as a library. Therefore, choose the target Lib when compiling NetworKit. The include directives in your C++-application look like the following
NetworKit in the directory include is a symlink to the directory networkit/cpp, so the directory structure from the repository is valid. To compile your application, you need to add the paths for the header files and the location of the library. Note, that it is possible to link the different builds (debug, profiling, optimized) of the library. There is a simple source file to demonstrate this. Feel free to compile LibDemo.cpp as follows:
g++ -o LibDemo -std=c++11 -I/path/to/repo/include -L/path/to/repo LibDemo.cpp -lNetworKit -fopenmp
You actually do not need to build and run our unit tests. However, if you experience any issues with NetworKit, you might want to check, if NetworKit runs properly. Please refer to the Unit Tests and Testing section in our NetworKit Development Guide.
ARCHFLAGS="-arch x86_64"to your setup/pip command, e.g. as in
sudo ARCHFLAGS="-arch x86_64" python3 setup.py build_ext --inplace -j4or
sudo ARCHFLAGS="-arch x86_64" pip3 install networkit.
ulimit -s unlimitedor
ulimit -Hs(to the hard limit if there is one). It is also possible to change resource limits from Python directly with
import resource; resource.setrlimit(resource.RLIMIT_STACK, (-1, -1)).
First make sure you have installed IPython, e.g. via pip:
pip3 install ipython.
If you want to use NetworKit in the IPython terminal, type the following commands in your OS terminal:
from networkit import *
The first line opens the IPython terminal. The second line imports the networkit Python module. After that, you should be able to use NetworKit interactively. For usage examples, refer to the NetworKit UserGuide.
Additionally, we recommend that you familiarize yourself with NetworKit through experimenting with the interactive IPython Notebook NetworKit_UserGuide.ipynb located in the folder Doc/Notebooks. The user guide also introduces a large portion of NetworKits functionality with usage examples. To display and work with these notebooks, you have to install jupyter and start a local notebook server from the terminal with:
If you run into any problems with jupyter, head over to the jupyter documentation. If the notebook server starts as it is supposed to, your default browser should open a web interface or you have to open it manually. Then you can add NetworKit_UserGuide.ipynb from the above mentioned location or browse to the location through the web interface.
To show plots within the notebooks, place the following two lines at the beginning of your notebook:
%matplotlib inline matplotlib.pyplot as plt
Note: Instead of running jupyter, it may still be possible to run
ipython3 notebook. However, the notebook functionality of the ipython package is deprecated and has been moved to jupyter, which we strongly recommend.
Now that you are done installing NetworKit, you might want to try the following example:
>>> from networkit import * >>> g = generators.HyperbolicGenerator(1e5).generate() >>> overview(g) Network Properties for: G#5 nodes, edges 100000, 300036 directed? False weighted? False isolated nodes 1815 self-loops 0 density 0.000060 clustering coefficient 0.720003 min/max/avg degree 0, 1174, 6.000720 degree assortativity 0.001383 number of connected components 4026 size of largest component 78387 (78.39 %) >>> communities = community.detectCommunities(g, inspect=True) PLM(balanced,pc,turbo) detected communities in 0.14902853965759277 [s] solution properties: ------------------- ----------- # communities 4253 min community size 1 max community size 1821 avg. community size 23.5128 modularity 0.987991 ------------------- ----------- >>>