Get Started

Take a look at Installation or Build NetworKit from Source in order to install NetworKit as a Python3 package or directly build it from source.

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.

Installation

Requirements

You will need the following software to install NetworKit as a python package:

  • A modern C++ compiler, e.g.: g++ (>= 5.3) or clang++ (>= 3.9)

  • OpenMP for parallelism (usually ships with the compiler)

  • Python3 (3.5 or higher is supported)

    • Development libraries for Python3. The package name depends on your distribution. Examples:

      • Debian/Ubuntu: apt-get install python3-dev

      • RHEL/CentOS: dnf install python3-devel

  • Pip

  • CMake version 3.5 or higher (e.g., pip3 install cmake)

  • Build System: Make or Ninja

  • Cython version 0.29 or higher (e.g., pip3 install cython)

Linux

There are several ways to install NetworKit. Besides using pip3 (the common Python module way), it is also possible to get it via package manager channels like conda, spack and brew. The complete list of possibilities is available on Github . The following example uses pip3 for installation on a recent Debian/Ubuntu-based distribution. Asume you have a clean minimal system, you will first have to install all requirements:

# On Ubuntu or equivalent, python3 is pre-installed.

# Install compilation tools (includes compiler, OpenMP)
sudo apt install build-essential

# Install Python3, pip3
sudo apt install python3-dev python3-pip

# Install cmake, cython
pip3 install cmake cython

# And finally ... install NetworKit
pip3 install networkit

macOS

For macOS you can follow similar steps as shown for pip3 under Linux. However we recommend using brew for managing NetworKit installations. Apart from the compilation environment all other dependencies are handled the brew formula.

# Install xcode command line tools
xcode-select --install

# Install Homebrew (if needed)
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

# Install NetworKit via brew
brew install python3

Windows

With the release of NetworKit 9.0 we have an experimental support for Windows installations. While installation is also possible via pip, requirements include the official Python package and at least the free Community-Edition of Visual Studio.

You also have to make sure that MSVC-compiler (cl.exe) can be found during installation. One possible way to achieve this is to call pip from within the “Native Tools Command Prompt” provided by Visual Studio.

# Requirements: Official Python release is installed and cl.exe can be found.
# If "Native Tools Command Prompt" is used, cmake and ninja are already installed.

# Install cython
pip3 install cython

# And finally ... install NetworKit
pip3 install networkit

Windows 10

For Windows 10, it is also possible to use the Windows Subsystem for Linux See the official documentation on how to activate the Linux Subsystem.

The Linux Subsystem is fully compatible with NetworKit. After a successful installation, simply open a new command line and start a new bash shell. From there you can follow the instructions for Linux.

Build NetworKit from Source

You can clone NetworKit from GitHub with git or download the source code as a zip file.

For further information, we refer to the README file of our GitHub repository, which contains instructions for building NetworKit from source.

Use NetworKit with IPython

First make sure you have installed IPython, e.g. via pip: pip3 install ipython.

IPython Terminal

If you want to use NetworKit in the IPython terminal, type the following commands in your OS terminal:

ipython3
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.

IPython Notebook/Jupyter

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:

jupyter/ipython3 notebook

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
import 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.

NetworKit Usage Example

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
-------------------  -----------

>>>

Known Issues

  • Mac OS X 10.10 “Yosemite”: Some users have reported compilation problems on Yosemite with g++ 4.9. The compiler errors mention register problems. While the exact reason remains unclear, the actual issue seems to be that the compiler tries to perform a dual architecture build. Fix: Enforce a 64-bit build by prepending ARCHFLAGS="-arch x86_64" to your setup/pip command, e.g. as in sudo ARCHFLAGS="-arch x86_64" python3 setup.py build_ext --inplace -j4 or sudo ARCHFLAGS="-arch x86_64" pip3 install networkit.

  • NetworKit has not yet been successfully built on Windows 8 and below in a reproducible way. This is partially due to the fact that Windows ships without a C++ compiler which is necessary to build the Python extensions. Even with the Visual C++ Redistributable our attempts were not successful. Any help is appreciated. It may be possible to build NetworKit as a library on Windows in environments like MinGW or Cygwin.

  • Some algorithms (e.g. StronglyConnectedComponents) are implemented in a recursive manner and for large input may exceed the default stack size on your platform. To work around this issue, you can lift the stack size limit for your terminal process and subsequent child processes with ulimit -s unlimited or 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)).

  • On macOS, it can happen that the g++ compiler is unable to locate specific Linux-based header files. An example would be an error during the compilation of a C++ header which includes stdint. This can generate the following error message: fatal error: sys/_types/_int8_t.h: No such file or directory. This error will most likely happen on new systems or after a major system upgrade. In this case you need to (again) install the Xcode command line tools: xcode-select --install. Afterwards the code should compile completely.

Contributions

We would like to encourage contributions to the NetworKit source code. See the NetworKit Development Guide for instructions. For support please contact the mailing list.