Hypergraph Analysis Toolbox

_images/index_dyadic_decomp.png

Important Note

The software for HAT is complete, but the online documentation is a work in progress. Currently, the software is only accessable via git and the Mathworks file exchange, but it will be published via PiPy shortly.

Introduction

Hypergraph Analysis Toolbox (HAT) is a software suite for the analysis and visualization of hypergraphs and higher order structures. Motivated to investigate Pore-C data, HAT is intended as a general prupose, versatile software for hypergraph construction, visualization, and analysis. HAT addresses the following hypergraph problems:

  1. Construction

  2. Visualization

  3. Expansion and numeric representation

  4. Structral Properties

  5. Controllability

  6. Similarity Measures

The capabilities and use cases of HAT are outlined in this short notice.

Installation

MATLAB

The MATLAB distribution of HAT can be installed through either the MATLAB Central. A MathWorks .mltbx file can be downloaded from the site, and installed through the add on manager in the MATLAB Home environment. Once installed as a toolbox, you will have access to all HAT functionality.

The MATLAB distribution has the following dependencies:

  1. TenEig — Tensor Eigenpairs Solver

Python

The Python distribution of HAT may be installed through pip:

>> pip install HypergraphAnalysisToolbox

Information on the PiPy distribution is available here. Once installed, HAT may be imported into the Python invironment with the command:

import HAT              # Import package
import HAT.Hypergraph   # Hypergraph class
import HAT.plot         # Visualization tools

The Python distribution has the following dependencies:

  1. numpy

  2. scipy

  3. matplotlib

  4. itertools

Development Distribution

All implementations of HAT are managed through a common git repository. This is public, so it may be cloned and modified. If interested in modifying or contributing to HAT, please contact Joshua Pickard at jpic@umich.edu

Indices and tables