diff --git a/MANIFEST.in b/MANIFEST.in index b8af874..92306c0 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,9 @@ recursive-include graphblas_algorithms *.py +prune docs include setup.py include README.md include LICENSE include MANIFEST.in +docs/_static/img/logo-name-medium.png +docs/_static/img/graphblas-vs-igraph.png +docs/_static/img/graphblas-vs-networkx.png diff --git a/README.md b/README.md index 0136abe..b3aca8d 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,29 @@ -# **GraphBLAS Algorithms** - +![GraphBLAS Algorithms](docs/_static/img/logo-name-medium.svg) +
[![conda-forge](https://img.shields.io/conda/vn/conda-forge/graphblas-algorithms.svg)](https://anaconda.org/conda-forge/graphblas-algorithms) [![pypi](https://img.shields.io/pypi/v/graphblas-algorithms.svg)](https://pypi.python.org/pypi/graphblas-algorithms/) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/graphblas-algorithms)](https://pypi.python.org/pypi/graphblas-algorithms/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/python-graphblas/graphblas-algorithms/blob/main/LICENSE) +
[![Tests](https://github.com/python-graphblas/graphblas-algorithms/workflows/Tests/badge.svg?branch=main)](https://github.com/python-graphblas/graphblas-algorithms/actions) [![Coverage](https://codecov.io/gh/python-graphblas/graphblas-algorithms/branch/main/graph/badge.svg)](https://codecov.io/gh/python-graphblas/graphblas-algorithms) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7329185.svg)](https://doi.org/10.5281/zenodo.7329185) [![Discord](https://img.shields.io/badge/Chat-Discord-blue)](https://discord.com/invite/vur45CbwMz) -GraphBLAS algorithms written in Python with [Python-graphblas](https://python-graphblas.readthedocs.io/en/latest/). We are trying to target the NetworkX API algorithms where possible. +`graphblas-algorithms` is a collection of GraphBLAS algorithms written using +[`python-graphblas`](https://python-graphblas.readthedocs.io/en/latest/). +It may be used directly or as an experimental +[backend to NetworkX](https://networkx.org/documentation/stable/reference/classes/index.html#backends). + +Why use GraphBLAS Algorithms? Because it is *fast*, *flexible*, and *familiar* by using the NetworkX API. + +Are we missing any [algorithms](#Plugin-Algorithms) that you want? +[Please let us know!](https://github.com/python-graphblas/graphblas-algorithms/issues) +
+GraphBLAS vs NetworkX +
+GraphBLAS vs igraph ### Installation ``` diff --git a/docs/_static/img/graphblas-vs-igraph.png b/docs/_static/img/graphblas-vs-igraph.png new file mode 100755 index 0000000..4c253d1 Binary files /dev/null and b/docs/_static/img/graphblas-vs-igraph.png differ diff --git a/docs/_static/img/graphblas-vs-networkx.png b/docs/_static/img/graphblas-vs-networkx.png new file mode 100755 index 0000000..bf9cb69 Binary files /dev/null and b/docs/_static/img/graphblas-vs-networkx.png differ diff --git a/docs/_static/img/logo-name-medium.svg b/docs/_static/img/logo-name-medium.svg new file mode 100644 index 0000000..81b7b01 --- /dev/null +++ b/docs/_static/img/logo-name-medium.svg @@ -0,0 +1 @@ +