# ceREEBerus: Reeb Graph Computations in Python

```{eval-rst}
.. image:: images/juggling_man.gif
  :width: 600 px
```

## Table of Contents

```{eval-rst}
.. toctree::
   :maxdepth: 1
   
   Contributing <contributing.rst>
   Modules and Documentation  <modules/index.md>
   Tutorial Notebooks <notebooks/index.md>
```

## About

`ceReeberus` is a Python package for working with Reeb graphs, in particular with a view towards using the interleaving distance in an applied context.

## Installation

You can either update the latest version from pip using

```{eval-rst}

.. code-block:: bash

  pip install cereeberus

```

or to work with the most up to date version, you can clone the [source code repository](https://github.com/MunchLab/ceREEBerus) and install with

```{eval-rst}

.. code-block:: bash

  git clone git@github.com:MunchLab/ceREEBerus.git
  cd ceREEBerus
  pip install .

```

## Collaborators

The code is a compilation of work done by [Elizabeth Munch](http://www.elizabethmunch.com) with her research group and collaborators. People who have made major contributions to ceREEBerus include:

- [Danielle Barnes](https://github.com/barnesd8)
- [Elena Wang](https://elenaxwang.com)

## Contact Information

- [Liz Munch](http://www.elizabethmunch.com): [muncheli@msu.edu](mailto:muncheli@msu.edu)