Metadata-Version: 2.1
Name: ringity
Version: 0.2a3
Summary: ringity package
Home-page: https://github.com/ClusterDuck123/ringity
Author: Markus K. Youssef
Author-email: mk.youssef@hotmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/kiri93/ringity/issues
Project-URL: Lab Origin, https://menchelab.com
Keywords: network ring circular tda
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE.txt

ringity
=======

|DOI| |license| |version|

ringity is a Python package to analyze networks in their global ring structure.

- **Source:** https://github.com/kiri93/ringity
- **Bug reports:** https://github.com/kiri93/ringity/issues
- **Contact Person:** mk.youssef@hotmail.com
- **Documentation:** Not available yet.

Notes
-----

This package is still under construction.

Simple example
--------------

Calculate ring score as described in [1]:

.. code:: python

    >>> 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.

Install
-------

Install the latest version of ringity::

    $ pip install ringity

Bugs
----

Please report any bugs that you find `here <https://github.com/kiri93/ringity/issues>`_.
Or, even better, fork the repository on `GitHub <https://github.com/kiri93/ringity/>`_
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 <https://doi.org/10.5281/ZENODO.4908927>`_


.. =================================
..         Badge definitions
.. =================================
.. |DOI| image:: https://img.shields.io/badge/DOI-10.5281%2FZENODO.4908927-orange
   :target: https://zenodo.org/badge/latestdoi/196970975
.. |license| image:: https://img.shields.io/github/license/kiri93/ringity
.. |version| image:: https://img.shields.io/github/v/tag/kiri93/ringity?style=social


