graspologic

graspologicis a package for graph statistical algorithms.

• Overview
• Documentation
• System Requirements
• Installation Guide
• Contributing
• License
• Issues
• Citinggraspologic

Overview

A graph, or network, provides a mathematically intuitive representation of data with some sort of relationship between items. For example, a social network can be represented as a graph by considering all participants in the social network as nodes, with connections representing whether each pair of individuals in the network are friends with one another. Naively, one might apply traditional statistical techniques to a graph, which neglects the spatial arrangement of nodes within the network and is not utilizing all of the information present in the graph. In this package, we provide utilities and algorithms designed for the processing and analysis of graphs with specialized graph statistical algorithms.

Documentation

The official documentation with usage is athttps://graspologic-org.github.io/graspologic/latest

Please visit thetutorial sectionin the official website for more in depth usage.

System Requirements

Hardware requirements

graspologicpackage requires only a standard computer with enough RAM to support the in-memory operations.

Software requirements

OS Requirements

graspologicis tested on the following OSes:

• Linux x64
• macOS x64
• Windows 10 x64

And across the followingx86_64versions of Python:

• 3.9
• 3.10
• 3.11
• 3.12

If you try to usegraspologicfor a different platform than the ones listed and notice any unexpected behavior, please feel free toraise an issue.It's better for ourselves and our users if we have concrete examples of things not working!

Installation Guide

Install from pip

pip install graspologic

Install from Github

git clone https://github.com/graspologic-org/graspologic
cd graspologic
python3 -m venv venv
source venv/bin/activate
python3 setup.py install

Contributing

We welcome contributions from anyone. Please see ourcontribution guidelinesbefore making a pull request. Our issuespage is full of places we could use help! If you have an idea for an improvement not listed there, please make an issuefirst so you can discuss with the developers.

License

This project is covered under the MIT License.

Issues

We appreciate detailed bug reports and feature requests (though we appreciate pull requests even more!). Please visit ourissuespage if you have questions or ideas.

Citinggraspologic

If you findgraspologicuseful in your work, please cite the package via theGraSPy paper

Chung, J., Pedigo, B. D., Bridgeford, E. W., Varjavand, B. K., Helm, H. S., & Vogelstein, J. T. (2019). GraSPy: Graph Statistics in Python. Journal of Machine Learning Research, 20(158), 1-7.