Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GiulioRossetti/cdlib
Community Discovery Library
https://github.com/GiulioRossetti/cdlib
cdlib community-detection community-discovery community-evaluation complex-networks igraph network-analysis networkx
Last synced: about 1 month ago
JSON representation
Community Discovery Library
- Host: GitHub
- URL: https://github.com/GiulioRossetti/cdlib
- Owner: GiulioRossetti
- License: bsd-2-clause
- Created: 2018-12-01T12:56:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-18T12:01:37.000Z (10 months ago)
- Last Synced: 2024-02-18T13:22:35.422Z (10 months ago)
- Topics: cdlib, community-detection, community-discovery, community-evaluation, complex-networks, igraph, network-analysis, networkx
- Language: Python
- Homepage: http://cdlib.readthedocs.io
- Size: 1.64 MB
- Stars: 339
- Watchers: 7
- Forks: 70
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ai - cdlib: Community Discovery Library - (for networkx and igraph)
README
# CDlib - Community Detection Library
[](https://codecov.io/gh/GiulioRossetti/cdlib)
[](https://github.com/GiulioRossetti/cdlib/actions/workflows/python-package.yml)
[](http://cdlib.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/GiulioRossetti/cdlib/actions/workflows/codeql-analysis.yml)
[](https://badge.fury.io/py/cdlib)
[](https://badge.fury.io/py/cdlib)
[](https://anaconda.org/giuliorossetti/cdlib)
[](https://github.com/psf/black)
[](https://pepy.tech/project/cdlib)
[](https://pepy.tech/project/cdlib)
[](https://doi.org/10.5281/zenodo.4575156)
[](https://sobigdata.d4science.org/group/sobigdata-gateway/explore?siteId=20371853)
``CDlib`` is a meta-library for community detection 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 (acknowledged on the [documentation](https://cdlib.readthedocs.io)).
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]()
## Tutorial and Online Environments
Check out the official [tutorial](https://colab.research.google.com/github/GiulioRossetti/cdlib/blob/master/docs/CDlib.ipynb) to get started!
If you would like to test ``CDlib`` functionalities without installing anything on your machine consider using the preconfigured Jupyter Hub instances offered by [SoBigData++](https://sobigdata.d4science.org/group/sobigdata-gateway/explore?siteId=20371853).
## Installation
``CDlib`` *requires* python>=3.8.
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
```
or conda
```bash
conda create -n cdlib python=3.9
conda config --add channels giuliorossetti
conda config --add channels conda-forge
conda install cdlib
```
### Optional Dependencies (pip package)
To simplify the installation process, the default installation does not include optional dependencies (e.g., ``graph-tool``). If you need them, you can install them manually or run the following command:
```bash
pip install 'cdlib[C]'
```
This option, safe for *nix users, will install all those optional dependencies that require C code compilation.
```bash
pip install 'cdlib[pypi]'
```
This option will install all those optional dependencies that are not available on conda/conda-forge.
```bash
pip install 'cdlib[all]'
```
This option will install all optional dependencies accessible with the flag ``C`` and ``pypi``.
#### (Advanced)
Due to some strict requirements, the installation of a subset of optional dependencies is left outside the previous procedures.
##### graph-tool
``CDlib`` integrates the support for SBM models offered by ``graph-tool``.
To install it refer to the official [documentation](https://git.skewed.de/count0/graph-tool/wikis/installation-instructions) and install the conda-forge version of the package (or the deb version if in a *nix system).
##### ASLPAw
Since its 2.1.0 release ``ASLPAw`` relies on ``gmpy2`` whose installation through pip is not easy to automatize due to some C dependencies.
To address such issue test the following recipe:
```bash
conda install gmpy2
pip install shuffle_graph>=2.1.0 similarity-index-of-label-graph>=2.0.1 ASLPAw>=2.1.0
```
In case this does not solve the issue, please refer to the official ``gmpy2`` [installation](https://gmpy2.readthedocs.io/en/latest/intro.html#installation) instructions.
### Optional Dependencies (Conda package)
``CDlib`` relies on a few packages not available through conda: to install them please use pip.
```bash
pip install pycombo
pip install GraphRicciCurvature
conda install gmpy2
pip install shuffle_graph>=2.1.0 similarity-index-of-label-graph>=2.0.1 ASLPAw>=2.1.0
```
In case ASLPAw installation fails, please refer to the official ``gmpy2`` [installation](https://gmpy2.readthedocs.io/en/latest/intro.html#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).