pyfglt 0.3.0
Python package/wrapper of Fast Graphlet Transform
License: Apache-2.0
Requires Python: >=3.8

# pyfglt

[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](https://fcdimitr.github.io/pyfglt/)
[![PyPI](https://img.shields.io/pypi/v/pyfglt.svg)](https://pypi.org/project/pyfglt/)
[![Tests](https://github.com/fcdimitr/pyfglt/actions/workflows/test.yml/badge.svg)](https://github.com/fcdimitr/pyfglt/actions/workflows/test.yml)
[![Changelog](https://img.shields.io/github/v/release/fcdimitr/pyfglt?include_prereleases&label=changelog)](https://github.com/fcdimitr/pyfglt/releases)
[![License](https://img.shields.io/github/license/fcdimitr/pyfglt)](https://github.com/fcdimitr/pyfglt/blob/main/LICENSE)

Python package/wrapper of Fast Graphlet Transform. See the [documentation
overview](https://fcdimitr.github.io/pyfglt/) for more information.

## Installation

Install this library using `pip`:
```bash
pip install pyfglt
```
## Usage

See the examples under:

- [Getting started](https://fcdimitr.github.io/pyfglt/tutorial/01-getting-started)
- [Advanced usage](https://fcdimitr.github.io/pyfglt/tutorial/02-graphlet-based-network-properties)

## Citation

If you use this package, please cite this paper:

```bibtex
@article{fglt,
    author = {Floros, Dimitris and Pitsianis, Nikos and Sun, Xiaobai},
    journal = {IEEE HPEC},
    pages = {1--8},
    title = {{Fast graphlet transform of sparse graphs}},
    year = {2020}
}
```

## **How to Contribute?**
If you’d like to contribute, feel free to submit a PR! 🚀


To contribute to this library, first checkout the code. Then create a new virtual environment:
```bash
cd pyfglt
python -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
python -m pip install -e '.[test]'
```
To run the tests:
```bash
python -m pytest
```

## **Contributors**

Below is a categorized list of contributors.

### **Design and Development**

<table>
  <tr>
    <td align="center"><a href="https://github.com/fcdimitr"><img src="https://github.com/fcdimitr.png" width="60px;" alt=""/><br /><sub><b>Dimitris Floros<br/>@fcdimitr</b></sub></a></td>
    <td align="center"><a href="https://github.com/pitsianis"><img src="https://github.com/pitsianis.png" width="60px;" alt=""/><br /><sub><b>Nikos Pitsianis<br/>@pitsianis</b></sub></a></td>
    <td align="center"><a href="https://spire.duke.edu/xiaobai-sun"><img src="https://spire.duke.edu/sites/spire.duke.edu/files/styles/square_small/public/2022-08/xiaobai%20%281%29.jpg?h=735f7c84&itok=mUth7Zqn" width="60px;" alt=""/><br /><sub><b>Xiaobai Sun<br/> _ </b></sub></a></td>
  </tr>
</table>

---

### **Development of Python & Julia Wrappers**

<table>
  <tr>
    <td align="center"><a href="https://github.com/nsailor"><img src="https://github.com/nsailor.png" width="60px;" alt=""/><br /><sub><b>Jason Barmparesos<br/>@nsailor</b></sub></a></td>
    <td align="center"><a href="https://github.com/kitsiosk"><img src="https://github.com/kitsiosk.png" width="60px;" alt=""/><br /><sub><b>Kitsios Konstantinos<br/>@kitsiosk</b></sub></a></td>
  </tr>
</table>

---

### **Helpful Comments and Bug Fixes**

<table>
  <tr>
    <td align="center"><a href="https://github.com/georgebisbas"><img src="https://github.com/georgebisbas.png" width="60px;" alt=""/><br /><sub><b>George Bisbas<br/>@georgebisbas</b></sub></a></td>
  </tr>
</table>

<!-- ---

### **🫶 We Also Thank the Following People**
We appreciate the valuable feedback, discussions, and testing provided by:

- [@username7](https://github.com/username7)
- [@username8](https://github.com/username8)
- [@username9](https://github.com/username9) -->

---