Skip to content

Installation

Prerequisites

  • Python 3.12 or higher
  • uv package manager (recommended)
  • Graphviz (for diagram rendering)
  1. Clone the repository:

    git clone https://github.com/UCL-ARC/HyperGraph-Isomorphism-Checker
    cd HyperGraph-Isomorphism-Checker
    

  2. Install system dependencies:

    make install-system
    

  3. Install Python dependencies:

    make install
    

Install with pip

If you prefer using pip and virtualenv:

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install dependencies
pip install -e .
pip install -e ".[dev]"

Install Graphviz

Ubuntu/Debian

sudo apt-get install graphviz

macOS

brew install graphviz

Windows

Download and install from graphviz.org

Verify Installation

from IsomorphismChecker_python_serial.node import Node

# Create a simple node
node = Node(index=0, label="test")
print(f"Node created: {node.label}")

Development Setup

For development with pre-commit hooks:

make setup

This will: - Install all dependencies - Set up pre-commit hooks - Configure the development environment

Running Tests

make test

Or with coverage:

pytest --cov=IsomorphismChecker_python_serial