Metadata-Version: 2.1
Name: cdlib
Version: 0.2.0
Summary: Community Discovery Library
Home-page: https://github.com/GiulioRossetti/cdlib
Author: Giulio Rossetti
Author-email: giulio.rossetti@gmail.com
License: BSD-Clause-2
Description: # CDlib - Community Discovery Library
        [![Coverage Status](https://coveralls.io/repos/github/GiulioRossetti/cdlib/badge.svg?branch=master)](https://coveralls.io/github/GiulioRossetti/cdlib?branch=master)
        [![Build Status](https://travis-ci.org/GiulioRossetti/cdlib.svg?branch=master)](https://travis-ci.org/GiulioRossetti/cdlib)
        [![Documentation Status](https://readthedocs.org/projects/cdlib/badge/?version=latest)](http://cdlib.readthedocs.io/en/latest/?badge=latest)
        [![Updates](https://pyup.io/repos/github/GiulioRossetti/cdlib/shield.svg)](https://pyup.io/repos/github/GiulioRossetti/cdlib/)
        [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/GiulioRossetti/nclib.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/GiulioRossetti/nclib/context:python)
        [![pyversions](https://img.shields.io/pypi/pyversions/cdlib.svg)](https://badge.fury.io/py/cdlib)
        [![PyPI version](https://badge.fury.io/py/cdlib.svg)](https://badge.fury.io/py/cdlib)
        [![PyPI download month](https://img.shields.io/pypi/dm/cdlib.svg?color=blue&style=plastic)](https://pypi.python.org/pypi/cdlib/)
        [![DOI](https://zenodo.org/badge/159944561.svg)](https://zenodo.org/badge/latestdoi/159944561)
        <!---
        [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FGiulioRossetti%2Fcdlib.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FGiulioRossetti%2Fcdlib?ref=badge_shield)
        --->
        
        ``CDlib`` is a meta-library for community discovery in complex networks: it implements algorithms, clustering fitness functions as well as visualization facilities.
        
        
        ``CDlib`` is designed around the ``networkx`` python library: however, when needed, it takes care to automatically convert (from and to) ``igraph`` object so to provide an abstraction on specific algorithm implementations to the final user.
        
        ``CDlib`` provides a standardized input/output facilities for several Community Discovery algorithms: whenever possible, to guarantee literature coherent results, implementations of CD algorithms are inherited from their original projects (see for instance [Infomap](https://pypi.org/project/infomap/),
        [Louvain](https://github.com/taynaud/python-louvain), [Leiden](https://github.com/vtraag/leidenalg)).
        
        The original projects embedded in `CDlib` are acknowledged on the documentation website: 
        here [the complete list of the CD methods included in the library](https://cdlib.readthedocs.io/en/latest/bibliography.html).
        
        Check out the official [tutorial](https://colab.research.google.com/github/GiulioRossetti/cdlib/blob/master/docs/CDlib.ipynb) to get started!
        
        If you use ``CDlib`` as support to your research consider citing:
        
        > G. Rossetti, L. Milli, R. Cazabet.
        > **CDlib: a Python Library to Extract, Compare and Evaluate Communities from Complex Networks.**
        > Applied Network Science Journal. 2019. 
        > [DOI:10.1007/s41109-019-0165-9]()
        
        ## Installation
        
        ``CDlib`` *requires* python>=3.6.
        
        To install the latest version of our library just download (or clone) the current project, open a terminal and run the following commands:
        ```bash
        pip install -r requirements.txt
        pip install -r requirements_optional.txt # (Optional) this might not work in Windows systems due to C-based dependencies.
        pip install .
        ```
        
        Alternatively use pip:
        ```bash
        pip install cdlib
        ```
        
        ### Optional Dependencies
        ``CDlib`` relies on a few packages calling C code (namely: ``python-igraph``, ``leidenalg``, ``angel_cd`` and ``infomap``).
        The default installation will not set up such requirements since their configuration under non *nix systems is not trivial and cannot be easily automated.
        
        Such a choice has been made to allow (even) Windows user to install the library and get access to its core functionalities. 
        
        To made available (most of) the optional packages you can either:
        
        - (Windows) manually install the optional packages (versions details are specified in ``requirements_optional.txt``) following the original projects guidelines, or
        - (Linux/OSX) run the command:
        
        ```bash
        pip install cdlib[C]
        ```
        
        Such caveat will install everything that can be easily automated under Linux/OSX. 
        
        #### (Advanced) Graph-tool
        The only optional dependency that will remain unsatisfied following the previous procedures will be ``graph-tool`` (used to add SBM models). 
        If you need it up and running, refer to the official [documentation](https://git.skewed.de/count0/graph-tool/wikis/installation-instructions).
        
        ## Collaborate with us!
        
        ``CDlib`` is an active project, any contribution is welcome!
        
        If you like to include your model in CDlib feel free to fork the project, open an issue and contact us.
        
        ### How to contribute to this project?
        
        Contributing is good, doing it correctly is better! Check out our [rules](https://github.com/GiulioRossetti/cdlib/blob/master/.github/CONTRIBUTING.md), issue a proper [pull request](https://github.com/GiulioRossetti/cdlib/blob/master/.github/PULL_REQUEST_TEMPLATE.md) /[bug report](https://github.com/GiulioRossetti/cdlib/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) / [feature request](https://github.com/GiulioRossetti/cdlib/blob/master/.github/ISSUE_TEMPLATE/feature_request.md).
        
        We are a welcoming community... just follow the [Code of Conduct](https://github.com/GiulioRossetti/cdlib/blob/master/.github/CODE_OF_CONDUCT.md).
        
        
        ## License
        [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FGiulioRossetti%2Fcdlib.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FGiulioRossetti%2Fcdlib?ref=badge_large)
        
Keywords: community-discovery node-clustering edge-clustering complex-networks
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Other
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Provides-Extra: C
