ect: Euler Characteristic Transform in Python

The ect package is a library of tools for computing the Euler Characteristic Transform of embedded cell complexes with arbitrary dimensional cells. This package is to aid researchers and practitioners in topological data analysis and related fields (such as computational geometry, network science, and biological shape analysis) who require scalable, Python-native tools for extracting and using topological features from embedded complexes.

Table of Contents

Contents:

• 1. Getting Started
• 2. Modules
• 3. Tutorials
• 4. Contributing
• 5. License
• 6. Citing

Description

This package provides tools for computing the Euler Characteristic Transform (ECT) of embedded cell complexes efficienctly and provides many useful utilities for visualizing and comparing different ECTs.

For more information on the ECT, see:

Munch, Elizabeth. An Invitation to the Euler Characteristic Transform. The American Mathematical Monthly, 132(1), 15-25. doi:10.1080/00029890.2024.2409616. 2024.

Getting Started

Documentation and tutorials

• The documentation is available at: munchlab.github.io/ect

• A comprehensive tutorial for the unified EmbeddedComplex class can be found here

• The source code can be found at: github.com/MunchLab/ect

Dependencies

• networkx

• numpy

• matplotlib

• numba

Installing

The package can be installed using pip:

pip install ect

Alternatively, you can clone the repo and install directly

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

Authors

This code was written by Liz Munch along with her research group and collaborators. People who have contributed to ect include:

• Sarah McGuire

• Yemeen Ayub

License

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

Contact Information

• Liz Munch: Website, Email