Infomap Python API¶

Infomap is a network clustering algorithm based on the Map equation.

API Reference¶

infomap module

Installation¶

Infomap is available on PyPI. Install it with:

pip install infomap

Upgrade an existing installation with:

pip install --upgrade infomap

Usage¶

Command line¶

Installing the Python package also provides an infomap executable. To verify that the CLI is available, run:

infomap -v

Command line usage is as follows:

infomap [options] network_data destination

For a list of available options, run:

infomap --help

Python package¶

Import the package with:

import infomap

A simple example:

from infomap import Infomap

# Command line flags can be provided as a string
im = Infomap("--two-level --directed")

# Add weight as optional third argument
im.add_link(0, 1)
im.add_link(0, 2)
im.add_link(0, 3)
im.add_link(1, 0)
im.add_link(1, 2)
im.add_link(2, 1)
im.add_link(2, 0)
im.add_link(3, 0)
im.add_link(3, 4)
im.add_link(3, 5)
im.add_link(4, 3)
im.add_link(4, 5)
im.add_link(5, 4)
im.add_link(5, 3)

# Run the search
im.run()

print(f"Found {im.num_top_modules} modules with codelength: {im.codelength}")

print("Result")
print("\n#node module")
for node in im.tree:
    if node.is_leaf:
        print(node.node_id, node.module_id)

Reusable options¶

Use infomap.InfomapOptions when you want to reuse the same configuration across multiple runs:

from infomap import Infomap, InfomapOptions

options = InfomapOptions(
    two_level=True,
    directed=True,
    silent=True,
    num_trials=20,
)

im = Infomap.from_options(options)
im.add_link(0, 1)
im.add_link(1, 2)
im.run()

# Reuse the same settings on another instance or another run
im2 = Infomap(silent=True)
im2.add_link(2, 3)
im2.run_with_options(options)

NetworkX graphs¶

Infomap.add_networkx_graph() accepts standard, state, and multilayer NetworkX graphs. Non-integer node labels are mapped to stable internal ids in first-seen order and returned as a mapping:

import networkx as nx
from infomap import Infomap

graph = nx.Graph([("a", "b"), ("a", "c")])
im = Infomap(silent=True)
mapping = im.add_networkx_graph(graph)
im.run()

State and multilayer networks¶

State networks are inferred from a phys_id node attribute, and multilayer networks additionally use layer_id:

import networkx as nx
from infomap import Infomap

graph = nx.Graph()
graph.add_node("state-a", phys_id="a", layer_id=1)
graph.add_node("state-b", phys_id="b", layer_id=1)
graph.add_node("state-a-next", phys_id="a", layer_id=2)
graph.add_edge("state-a", "state-b")
graph.add_edge("state-a", "state-a-next")

im = Infomap(silent=True)
im.add_networkx_graph(graph)
im.run()

Please read the infomap module reference to learn more.