Metadata-Version: 2.1
Name: ect
Version: 0.1.6
Summary: A python package for computing the Euler Characteristic Transform
Author-email: Liz Munch <muncheli@msu.edu>
Project-URL: Homepage, https://munchlab.github.io/ect
Project-URL: Repository, https://github.com/MunchLab/ect
Project-URL: Issues, https://github.com/MunchLab/ect/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: networkx
Requires-Dist: matplotlib
Requires-Dist: numba
Requires-Dist: scipy

# `ect`: A python package for computing the Euler Characteristic Transform

Python computation tools for computing the Euler Characteristic Transform of embedded graphs. 

## Description

Right now, the content includes stuff for doing ECT on graphs embedded in 2D. Eventually the goal is to get voxel versions, higher dimensional simplicial complexes, etc in here.

For more information on the ECT, see:

> Elizabeth Munch. An Invitation to the Euler Characteristic Transform. [arXiv:2310.10395](https://arxiv.org/abs/2310.10395). 2023.

## Getting Started

### Documentation and tutorials

- The documentation is available at: [munchlab.github.io/ect](https://munchlab.github.io/ect/)
- A tutorial jupyter notebook can be found [here](https://munchlab.github.io/ect/notebooks/Tutorial-ECT_for_embedded_graphs.html)

### Dependencies

- `networkx`
- `numpy`
- `matplotlib`
- `numba`

### Installing

The package can be installed using pip:

```{bash}
pip install ect
```

Alternatively, you can clone the repo and install directly

```{bash}
git clone git@github.com:MunchLab/ect.git
cd ect
pip install .
```

## Authors

This code was written by [Liz Munch](https://elizabethmunch.com/) along with her research group and collaborators. People who have contributed to `ect` include:

- [Sarah McGuire](https://www.sarah-mcguire.com/)

## License

This project is licensed under the GPLv3 License - see the License file for details

## Contact Information

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