Node Labeling

This repository implements a two-phase algorithm for labeling line diagrams of ordered sets.

Usage

Install via PyPI

Install the package from PyPI using pip.

pip install node-labeling

Execute the layout generation using the node-labeling command.

node-labeling

Install from source

Clone the repository and initialize the environment. uv will automatically create a virtual environment and sync dependencies based on the pyproject.toml.

uv sync

Execute the layout generation using uv run to ensure the correct environment context.

uv run node-labeling

The script will prompt you for a path to a .graphml file. Each node needs x/y position data, and optionally general data as a plain string and extent/intent label data (;-separated names). To export the final layout to a PDF add the --export flag.

uv run node-labeling --export

The --export flag also works with the PyPI install:

node-labeling --export

Use as a library

Node Labeling can also be called directly from Python via node_labeling.label.

from node_labeling import label

# graphml is a path to a .graphml file
labels = label('path/to/graph.graphml')

By default label returns the final label placement for every node as a dict mapping label id to LabelCandidate. Pass export=True to instead write the final layout to a PDF in figs/.

label('path/to/graph.graphml', export=True)

Pass a Config instance to override any parameter listed below.

from node_labeling import label
from node_labeling.utils.config import Config

labels = label('path/to/graph.graphml', cfg=Config(top_k=200))

Configuration

License

Shield:

This work is licensed under a Creative Commons Attribution 4.0 International License.