diff --git a/README.md b/README.md index c34ede9b..ded3d8aa 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,12 @@ This is an implementation of the [Chinese Whispers](https://doi.org/10.3115/1654 [conda_badge]: https://img.shields.io/conda/vn/conda-forge/chinese-whispers.svg [conda_link]: https://anaconda.org/conda-forge/chinese-whispers +## Installation + +- [pip](https://pip.pypa.io/): `pip install chinsese_whispers` +- [Anaconda](https://docs.conda.io/en/latest/): `conda install -c conda-forge chinese-whispers` +- [Mamba](https://mamba.readthedocs.io/): `mamba install -c conda-forge chinese-whispers` + ## Usage Given a NetworkX graph `G`, this library can [cluster](https://en.wikipedia.org/wiki/Cluster_analysis) it using the following code: diff --git a/docs/index.md b/docs/index.md index 0ac3b13c..a8ddb7e0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,6 +2,12 @@ This is an implementation of the [Chinese Whispers](https://doi.org/10.3115/1654758.1654774) clustering algorithm in Python. Since this library is based on [NetworkX](https://networkx.github.io/), it is simple to use. +## Installation + +- [pip](https://pip.pypa.io/): `pip install chinsese_whispers` +- [Anaconda](https://docs.conda.io/en/latest/): `conda install -c conda-forge chinese-whispers` +- [Mamba](https://mamba.readthedocs.io/): `mamba install -c conda-forge chinese-whispers` + ## Usage Given a NetworkX graph `G`, this library can [cluster](https://en.wikipedia.org/wiki/Cluster_analysis) it using the following code: