Description

This is a companion package to Teaspoon, and includes the modules of teaspoon that use zigzag persistence, and rely on dionysus. Many Teaspoon users did not need the full install that included additional system dependencies.

Full documentation of this package is available here. The full documentation includes information about installation, module documentation with examples, contributing, the license, and citing spork.

The code is a compilation of work done by Elizabeth Munch and Firas Khasawneh along with their students and collaborators. People who have contributed to spork include:

• Audun Myers
• Melih Yesilli
• Sarah Tymochko
• Danielle Barnes
• Sunia Tanweer
• Max Chumley
• Ismail Guzel

We gratefully acknowledge the support of the National Science Foundation, which has helped make this work possible.

Installation

To install this package, both boost and CMake must be installed as system dependencies. For boost see for unix and windows. For mac, you can run brew install boost if using homebrew as a package manager. For CMake see here.

The spork package is available through pip install with version details found here. The package can be installed using the following pip installation:

``pip install sporktda``

To install the most up-to-date version of the code, you can clone the repo and then run::

pip install .

from the main directory. Note that the master branch will correspond to the version available in pypi, and the test_release branch may have new features.

Please reference the requirements page in the documentation for more details on other required installations.

Contacts

• Liz Munch: muncheli@msu.edu.
• Firas Khasawneh: khasawn3@egr.msu.edu.