Welcome to Dionysus 2 documentation!

Dionysus 2 is the second incarnation of the library for computing persistent homology. As before, it’s written in C++, with Python bindings. The second version is re-written from scratch, which helps it accomplish a few goals:

Features that haven’t (yet) made it over from Dionysus 1 include vineyards, alpha shapes, bottleneck distance.

  • please use the dionysus mailing list for all questions and discussion related to the library;
  • GitHub’s issue tracker is a central location for bug reports and feature requests.

Get, Build, Install

The simplest way to install Dionysus as a Python package:

pip install --verbose git+https://github.com/mrzv/dionysus.git

Alternatively, you can clone and build everything by hand. To get Dionysus 2, either clone its repository:

git clone https://github.com/mrzv/dionysus.git

or download it as a Zip archive.

To build the project:

mkdir build
cd build
cmake ..

To use the Python bindings, either launch Python from .../build/bindings/python or add this directory to your PYTHONPATH variable, by adding:

export PYTHONPATH=.../build/bindings/python:PYTHONPATH

to your ~/.bashrc or ~/.zshrc.

Indices and tables