Skip to content

HyperGraph Isomorphism Checker

Welcome to the documentation for the Hypergraph Isomorphism Checker (HgIC) project!

Overview

The current version is a serial Python library for directed hypergraphs.

Key Features

  • 🔗 Graph Structures: Support for directed hypergraphs/graphs
  • ✅ Validation: Comprehensive validation of graph structures and signatures
  • 🎨 Visualization: Built-in support for rendering graphs using Graphviz
  • 🧪 Well-Tested: Extensive test coverage with pytest
  • 🚀 Type-Safe: Full type hints for better IDE support and code quality

Use Case

from IsomorphismChecker_python_serial.node import Node
from IsomorphismChecker_python_serial.edge import Edge
from IsomorphismChecker_python_serial.graph import Graph

# Create nodes
n1 = Node(index=0, label="A")
n2 = Node(index=1, label="B")

# Create edge
edge = Edge(source=n1, target=n2, label="f")

# Create graph
graph = Graph(nodes=[n1, n2], edges=[edge])

# Validate
if graph.is_valid():
    print("Graph is valid!")

Getting Started

Check out the Installation Guide to get started with the HgIC.

Project Structure

src/IsomorphismChecker_python_serial/
├── node.py              # Node definitions
├── edge.py              # Simple edge definitions
├── hyperedge.py         # Hyperedge definitions
├── graph.py             # Directed graph implementation
├── hypergraph.py        # Hypergraph implementation
├── signature.py         # Signature handling
├── diagram.py           # Graph visualization
├── validation.py        # Validation utilities
└── ...

Contributing

We welcome contributions! See our Contributing Guide for details.

Table of Contents