Skip to main content

Calculates ring scores for various data structures

Project description

DOI license version

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

Notes

This package is still under construction!

Simple network example

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.diagram(G)
>>> dgm.ring_score()
1

[1]: Paper not available yet.

Simple point cloud example

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

Latest Changes

  • Changed foldername data to _data

  • The persistent diagram class PersistenceDiagram has ring_score now as a method, not as a property. As a result, the function is now called via dgm.ring_score() insted of dgm.ring_score! (Notice the change in brackets) We appologize if this is breaking old code; such changes will be avoided in the future.

  • Integration of various ring-score “flavours”.

  • Extended usage for point clouds.

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

Released under the MIT License (see LICENSE.txt):

Copyright (c) 2019 Markus K. Youssef <mk.youssef@hotmail.com>

How to cite

If you want to cite this package, please use the DOI: 10.5281/ZENODO.4908927

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ringity-0.4a2.tar.gz (47.5 kB view details)

Uploaded Source

Built Distribution

ringity-0.4a2-py3-none-any.whl (52.4 kB view details)

Uploaded Python 3

File details

Details for the file ringity-0.4a2.tar.gz.

File metadata

  • Download URL: ringity-0.4a2.tar.gz
  • Upload date:
  • Size: 47.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.5

File hashes

Hashes for ringity-0.4a2.tar.gz
Algorithm Hash digest
SHA256 cef20381c46fb6de11c0a4d141a6ba5a08d5b616313be1ee7b109b1056a36f1d
MD5 65e662faa4a20aa41035af3facd26bfe
BLAKE2b-256 bda7dfb16cb087f3ebe97641057d0e699d0b3bdb7d08f4721f7f8fab286f70cc

See more details on using hashes here.

File details

Details for the file ringity-0.4a2-py3-none-any.whl.

File metadata

  • Download URL: ringity-0.4a2-py3-none-any.whl
  • Upload date:
  • Size: 52.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.5

File hashes

Hashes for ringity-0.4a2-py3-none-any.whl
Algorithm Hash digest
SHA256 2ee0f99eb5db6ed08fc5902b93b0e159236846afa57fb8032271fcf2948e40e2
MD5 bf03037ca1ea4d6624cbf40c9bc625f3
BLAKE2b-256 2b30184b8a0544f8a0b1aba28306be1908d10c4d33af77e17e328f228155d3b6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page