ringity 0.4a4

Calculates ring scores for various data structures

ringity is a Python package to analyze various data structures with respect to their ring structure.

• Source: https://github.com/ClusterDuck123/ringity

• Issues: https://github.com/ClusterDuck123/ringity/issues

• Docs: “coming soon”

🚀 Quick Examples

Ring Score of Networks

Calculate ring score as described in [1]:

import ringity as rng
import networkx as nx
G = nx.Graph()
G.add_edges_from([(i%100,(i+1)%100) for i in range(100)])
dgm = rng.pdiagram(G)   # constructs a persistence diagram from G
dgm.ring_score()        # -> 1

[1]: Paper not available yet.

Ring Score of Point Clouds

Calculate ring score as described in [2]:

import numpy as np
import ringity as rng
t = np.linspace(0, 2*np.pi, 100)
X = np.array((np.cos(t),np.sin(t))).T
rng.ring_score(X)     # -> 1

[2]: Paper not available yet.

📦 Install

Install the latest version of ringity:

$ pip install ringity

🐞 Bugs

Please report any bugs that you find here. Or, even better, fork the repository on GitHub and create a pull request. All inputs, suggestions and changes are more than welcome!

📄 License

MIT — see LICENSE.

📚 How to cite

DOI: 10.5281/zenodo.4908927