nielsborie/networkit-docker repository overview

⁠networkit-docker

⁠The networkit-docker is a ready-to-run Docker image containing the python library networkit and other things.

⁠What is Networkit?

NetworKit is a growing open-source toolkit for high-performance network analysis. Its aim is to provide tools for the analysis of large networks in the size range from thousands to billions of edges. For this purpose, it implements efficient graph algorithms, many of them parallel to utilize multicore architectures. These are meant to compute standard measures of network analysis, such as degree sequences, clustering coefficients and centrality. In this respect, NetworKit is comparable to packages such as NetworkX, albeit with a focus on parallelism and scalability. NetworKit is also a testbed for algorithm engineering and contains novel algorithms from recently published research.

More info at Networkit documentation⁠.

⁠What is igraph?

igraph is a collection of network analysis tools with the emphasis on efficiency, portability and ease of use. igraph is open source and free. igraph can be programmed in R, Python and C/C++.

More info at igraph documentation⁠.

⁠What is in there?

⁠Specs

This is what you get out of the box when you create a container with the provided image/Dockerfile:

• Ubuntu 18.04
• Jupyter Notebook
• Conda Python 3.6.x
• GCC/G++ 5
• Python Machine Learning : Numpy⁠, Pandas⁠, Matplotlib⁠, SciPy⁠, Seaborn⁠,scikit-learn⁠
• Python graph libraries : NetworkX⁠, Networkit⁠, python-igraph⁠
• Python Deep Learning : Tensorflow⁠, Keras⁠

⁠Setup

⁠Prerequisites

Install Docker following the installation guide for your platform: here⁠

⁠Obtaining the Docker image

• ⁠Option 1: Download the Docker image from Docker Hub

Available here : (https://hub.docker.com/r/nielsborie/networkit-docker/⁠)

docker pull nielsborie/networkit-docker

• ⁠Option 2: Build the Docker image locally

1. ⁠clone the repository

git clone https://github.com/nielsborie/networkit-docker.git
cd /networkit-docker

1. ⁠basic building :

docker build . -t networkit-docker

1. ⁠If you have a proxy issue execute the following line :

docker build . --no-cache --force-rm --build-arg http_proxy=<proxy> --build-arg https_proxy=<proxy> --build-arg no_proxy=localhost,<proxy>,<proxy>,.an.local -t networkit-docker

⁠Running the Docker image as a Container

Once we've built the image, we have all the frameworks we need installed in it. We can now spin up one or more containers using this image.

• ⁠Basic run

Simplest command to launch the container.

docker run --name NETWORKIT -p 8887:8888 nielsborie/networkit-docker

⁠If you don't want to be stick to your terminal, you can run it in detached mode (-d)

docker run --name NETWORKIT -d -p 8887:8888 nielsborie/networkit-docker

• ⁠Start & Stop

Once you create the container, all you need to do is launch it :

docker start NETWORKIT
docker stop NETWORKIT

• ⁠Enter in the running container

Since you launched the container, you can get in and be root inside the image!

docker exec -it NETWORKIT /bin/bash

• ⁠Customize your Container

• ⁠If you want a real password (and avoid copy/paste token step...)

docker run --name NETWORKIT -d -p 8887:8888 -d nielsborie/networkit-docker start-notebook.sh --NotebookApp.password="sha1:ff6a3551e13f:c3edadaa0cb4bed02293c96c14d755611069a4ba" 

• ⁠If you want to share your current working folder, you can map it with "-v" or "--volume"

docker run --name NETWORKIT -p 8887:8888 -d -v /sharedfolder:/home/jovyan/work/ -e NB_UID=<your-UID/> --user root nielsborie/networkit-docker start-notebook.sh --NotebookApp.password="sha1:ff6a3551e13f:c3edadaa0cb4bed02293c96c14d755611069a4ba"

⁠If you need to change the password check :

Jupyter notebook documentation⁠

⁠You can find additionnal info here :

Jupyter docker documentation⁠