Py-GraSPI Documentation
========================

Welcome to the documentation for **Py-GraSPI**.


About
------------

**Py-GraSPI** (Graph-based Structure Property Identifier) is a Python package designed to compute a comprehensive set of
descriptors for segmented microstructures using a graph-based approach. It leverages the **igraph** library to represent microstructures
as graphs, enabling efficient computation of a wide range of descriptors with low computational overhead. Py-GraSPI is the Python
implementation of the original **GraSPI package**, which was developed in C/C++. In addition to descriptor computation,
Py-GraSPI offers tools for data conversion across various formats and for post-processing the raw outputs of the graph analysis.



In Brief
------------
The Py-Graspi project provides tools for creating, filtering, and analyzing graphs, with benchmarks for runtime and memory performance.

.. toctree::
   :maxdepth: 10
   :caption: Contents:
   :includehidden:

   pyGraspiFunctionality
   pyGraspiDescriptors
   pyGraspiInputs
   installation
   pyGraspiExamples
   pyGraspiRepresentation
   pyGraspiDefinitions
   api_overview
   advanced


Authors
=======


- **Olga Wodo** – University at Buffalo
- **Baskar Ganapathysubramanian** – Iowa State University
- **Jaroslaw Zola** – University at Buffalo


Contributors
~~~~~~~~~~~~

Py-GraSPI has been developed collaboratively at the University at Buffalo and Iowa State University:

- **Olga Wodo** – University at Buffalo
- **Baskar Ganapathysubramanian** – Iowa State University
- **Jaroslaw Zola** – University at Buffalo
- **Devyani Jivani** – University at Buffalo
- **Wenqi Zheng** – University at Buffalo
- **Michael Leung** – University at Buffalo
- **Kevin Martinez** – University at Buffalo
- **Jerry Zhou** – University at Buffalo
- **Qi Pan** – University at Buffalo
- **Julia Joseph** – University at Buffalo
- **Laibah Ahmed** – University at Buffalo
- **Donghwi Seo** – University at Buffalo

Contact
~~~~~~~

For questions or inquiries, please contact:
**Olga Wodo** – ``olgawodo@buffalo.edu``