graph_presenter

Generates searchable DeepZoom presentations of Gephi graphs

Primarily maintained by Toke Eskildsen, toes@kb.dk, Royal Danish Library

Requirements

bash, wget, GraphicsMagic, vips (only tested under Ubuntu)
SVG exported from Gephi

Introduction

Gephi graphs (connected nodes) are hard to visualise at scale in a browser: Using a vectorised format, such as SVG, serious hardware is required for zoom & pan when the node count gets into the 10s or 100s of thousands.

graph_presenter renders the Gephi SVG output to a DeepZoom bitmap, which can then be displayed n a browser using OpenSeadragon. Name and location of nodes and edges are extracted, providing support for search and visual marking of nodes as well as finding shortest path between nodes.

The display of the DeepZoom bitmap works at arbitrary scale on most devices. Search works reasonably well on phones, while shortest path discovery on 100K+ nodes only works well on laptops or better.

The upper limit for graph complexity and search/shortest path functionality seems to be around 200K nodes with 800K edges. The limit is dictated by browser memory.

Demos

C64+Amiga domain graph from the Danish net archive - 57,432 nodes
"All" domains from 1998-2003 from the Danish net archive - 79,012 nodes

These demos provide search as well as shortest path discovery. For shortest path discovery select Connect in the drop-down; click on a domain-circle in the graph, then shift-click on another circle.

How-to

Generate a graph using Gephi and export is as a SVG.
Call ./generate_presentation.sh mygraph.svg mypresentation
Upload the generated folder mypresentation to a webserver or open mypresentation/index.html locally

The size of the rendered DeepZoom image can be controlled using RENDER_SIZE. The default is 20K pixels, suitable for testing and smaller (5K nodes) graphs. For a large graph with e.g. 100K nodes, something like 50K pixels is better:

RENDER_SIZE=50000 ./generate_presentation.sh mygraph.svg mypresentation

De-mystifying

The ./generate_presentation.sh script is at its core extremely simple:

Use GraphicsMagic to convert the SVG to PNG: gm convert -size 20000x20000 mygraph.svg mygraph.png
Create DeepZoom tiles from the png: vips dzsave mygraph.png mygraph --suffix .png
Extract node-names & coordinates: tr '\n' ' ' < mygraph.svg | grep -o "<circle [^/]*/>" | sed 's/<circle.* r="\([^"]*\)".* cx="\([^"]*\)".* class="id_\([^"]*\)".* cy="\([^"]*\)".*\/>/\3 \2 \4 \1/' | LC_ALL=C sort

The JavaScript domain_control.js supports search by looking sequentially through all the node-names generated in step #3 and getting their coordinates. For each of these coordinates, an overlay is added to the OpenSeadragon display.

The only tricky part is the code for finding the shortest path between two nodes: It uses Dijkstra's Shortest Path First algorithm with the state being represented using compact arrays instead of objects.

Notes & to-do

Rendering with GraphicsMagic in 50K is doable on a 16GB machine, but might take hours. More RAM helps a lot. vips is vastly superior for larger sizes.
GraphicsMagic has a problem with kerning for some renders.
Both render-size and font-kerning seems to have been solved in the latest version of vips described in the section below.
Moving search and shortest-path server-side would allow for larger scale renders, but introducing a backend would make it a lot more complicated to get a graph presentation to work

Adventures with vips

vips excels in handling large images, but due to to issue 732 and issue 1354 the current release (2019-07-01) cannot handle large SVGs.

Luckily these issues has been resolved in master and vips is simple to compile: Follow the instructions at Building libvips from git. For a specific Ubuntu-version of the instructions, see Build for Ubuntu / Building from source.

vips controls render-size of SVGs with dpi, but we can derive that from the input SVG and the wanted size in pixels. If we have 1998_to_2003.svg and want DeepZoom tiles for a virtual size of 160000x160000 pixels (25 gigapixel), we can do

echo $(( 160000 * 72 / $(head -n 100 1998_to_2003.svg | tr '\n' ' ' | grep -o '<svg[^<]*width="[0-9.]*"' | grep -o 'width=.*' | sed 's/^[^0-9]*\([0-9]*\).*/\1/') ))

For this case it gives us 366 DPI, which we feed to vips, together with the unlimited-option that allow us to render SVGs larger than 10MB:

vips dzsave '1998_to_2003.svg[dpi=366,unlimited]' 1998_to_2003_160K --suffix .png

All this is handled by the generate_presentation.sh script, so if a new version of vips has been compiled & installed as described above, the png-step can be skipped and the tiles rendered directly without GraphicsMagic, making it possible to create renderings of 25-50 GigaPixel on a machine with 16GB of RAM:

RENDER_SIZE=160000 RENDER_PNG=false VIPS_ONLY=true ./generate_presentation.sh 1998_to_2003.svg

kb-dk/graph_presenter