Merged

Add logo and benchmarks to README #60

Show file tree
Hide file tree
Changes from all commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f392d0d
Add logo and benchmarks to README
eriknwApr 15, 2023
1271e71
Add supported Python versions badge to README
eriknwApr 15, 2023
b8ee0a3
badges on two lines
eriknwApr 15, 2023
dda122d
Update logo
eriknwApr 21, 2023
db9cbc3
Change svg logo to png to avoid font issues
jim22kApr 22, 2023
0850421
minify png with https://tinypng.com
eriknwApr 22, 2023
e840706
convert svg font to path and minify with https://vecta.io/nano (and d…
eriknwApr 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Failed to load files.
Original file line numberDiff line numberDiff line change
@@ -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
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,29 @@
# **GraphBLAS Algorithms**

![GraphBLAS Algorithms](docs/_static/img/logo-name-medium.svg)
<br>
[![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://.com/python-graphblas/graphblas-algorithms/blob/main/LICENSE)
<br>
[![Tests](https://.com/python-graphblas/graphblas-algorithms/workflows/Tests/badge.svg?branch=main)](https://.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)
<!--- [![Docs](https://readthedocs.org/projects/graphblas-algorithms/badge/?version=latest)](https://graphblas-algorithms.readthedocs.io/en/latest/) --->

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://.com/python-graphblas/graphblas-algorithms/issues)
<br>
<img src="docs/_static/img/graphblas-vs-networkx.png" alt="GraphBLAS vs NetworkX" title="Even faster than scipy.sparse!" width="640" />
<br>
<img src="docs/_static/img/graphblas-vs-igraph.png" alt="GraphBLAS vs igraph" title="igraph may use different algorithms for PageRank" width="600" />

### Installation
```
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a small thing, but the last letter in "graphblas" is a bit cropped out. I think it still works, though, so not a serious issue.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really? I don't think I see that. Can you take a screenshot of what you are seeing?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2023-04-18 at 09 11 26

I checked Chrome and Safari, both look like this for me...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And now that I'm looking at it again, the last s in algorithms is also gone... Interesting.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried playing around with zoom to see if that would make a diff, but nope.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see this now (on my macbook); it renders fine for me on Windows where I created it. Thanks for letting me know!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I think the logo should be fixed now if you'd like to take a look to verify.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To recap testing on my end: looks good on MacOS and Windows, looks truncated on Ubuntu.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.