.. image:: https://github.com/mapequation/infomap/actions/workflows/build.yml/badge.svg
Infomap
=======
Infomap is a network clustering algorithm based on the `Map equation`_.
For detailed documentation, see `mapequation.org/infomap`_.
For a list of recent changes, see `CHANGELOG.md`_ in the source directory.
.. _Map equation: https://www.mapequation.org/publications.html#Rosvall-Axelsson-Bergstrom-2009-Map-equation
.. _`mapequation.org/infomap`: https://www.mapequation.org/infomap
.. _`CHANGELOG.md`: https://github.com/mapequation/infomap/blob/master/CHANGELOG.md
Getting started
---------------
Infomap can be installed either from `PyPI`_ using ``pip`` or by
compiling from source.
An experimental Javascript version for browsers is available on `NPM`_.
.. _PyPI: https://pypi.org/project/infomap/
Using pip
---------
A pre-compiled version is available for macOS users.
Installing on other operating systems requires a
working ``gcc`` or ``clang`` compiler.
To install, run::
pip install infomap
To upgrade, run::
pip install --upgrade infomap
When the Python package is installed, an executable called
``infomap`` (with lowercase i) is available from any directory.
To get started, read `Infomap Python API`_.
.. _`Infomap Python API`: https://mapequation.github.io/infomap/python/
Using Docker
------------
There are currently two Docker images available on `Docker Hub`_.
- ``mapequation/infomap``
- ``mapequation/infomap:notebook`` based on ``jupyter/scipy-notebook``
The image ``mapequation/infomap`` can be started with
.. code-block:: bash
docker run -it --rm \
-v `pwd`:/data \
mapequation/infomap
[infomap arguments]
You can also use the supplied `docker-compose.yml`_:
.. code-block:: bash
docker-compose run --rm infomap
The image ``mapequation/infomap:notebook`` can be started with
.. code-block:: bash
docker run \
-v `pwd`:/home/jovyan/work \
-p 8888:8888 \
mapequation/infomap:notebook \
start.sh jupyter lab
Or similarly, using docker-compose:
.. code-block:: bash
docker-compose up notebook
.. _`Docker Hub`: https://hub.docker.com/r/mapequation/infomap
.. _`docker-compose.yml`: https://github.com/mapequation/infomap/blob/master/docker-compose.yml
Compiling from source
---------------------
Installing Infomap from source requires a working ``gcc`` or ``clang`` compiler.
To download and compile the newest version from `Github`_, clone the repository
by running
.. code-block:: shell
git clone git@github.com:mapequation/infomap.git
cd infomap
make
This creates the binary ``Infomap``, run it using::
./Infomap [options] network_data destination
For a list of options, run::
./Infomap --help
Read `the documentation`_ to learn more about the different options.
.. _Github: https://www.github.com/mapequation/infomap
.. _the documentation: https://www.mapequation.org/infomap
Npm package
-----------
An experimental Javascript web worker is available on `NPM`_.
To install it, run
.. code-block:: shell
npm install @mapequation/infomap
.. _NPM: https://www.npmjs.com/package/@mapequation/infomap
Feedback
--------
If you have any questions, suggestions or issues regarding the software,
please add them to `GitHub issues`_.
.. _Github issues: http://www.github.com/mapequation/infomap/issues
Authors
-------
Daniel Edler, Anton Holmgren, Martin Rosvall
For contact information, see `mapequation.org/about.html`_.
.. _`mapequation.org/about.html`: https://www.mapequation.org/about.html
Terms of use
------------
Infomap is released under a dual licence.
To give everyone maximum freedom to make use of Infomap
and derivative works, we make the code open source under
the GNU Affero General Public License version 3 or any
later version (see `LICENSE_AGPLv3.txt`_).
For a non-copyleft license, please contact us.
.. _LICENSE_AGPLv3.txt: https://github.com/mapequation/infomap/blob/master/LICENSE_AGPLv3.txt
Raw data
{
"_id": null,
"home_page": "https://mapequation.github.io/infomap/",
"name": "infomap",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "map-equation network-analysis community-detection clustering-algorithm",
"author": "mapequation",
"author_email": "mapequation@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ce/bb/32a2f3bbea80407ec1af1d0730d8d46208f8be0bb797d0e1d1e4da4128e4/infomap-2.7.1.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/mapequation/infomap/actions/workflows/build.yml/badge.svg\n\nInfomap\n=======\n\nInfomap is a network clustering algorithm based on the `Map equation`_.\n\nFor detailed documentation, see `mapequation.org/infomap`_.\n\nFor a list of recent changes, see `CHANGELOG.md`_ in the source directory.\n\n.. _Map equation: https://www.mapequation.org/publications.html#Rosvall-Axelsson-Bergstrom-2009-Map-equation\n.. _`mapequation.org/infomap`: https://www.mapequation.org/infomap\n.. _`CHANGELOG.md`: https://github.com/mapequation/infomap/blob/master/CHANGELOG.md\n\nGetting started\n---------------\n\nInfomap can be installed either from `PyPI`_ using ``pip`` or by\ncompiling from source.\n\nAn experimental Javascript version for browsers is available on `NPM`_.\n\n.. _PyPI: https://pypi.org/project/infomap/\n\nUsing pip\n---------\n\nA pre-compiled version is available for macOS users.\n\nInstalling on other operating systems requires a\nworking ``gcc`` or ``clang`` compiler.\n\nTo install, run::\n\n pip install infomap\n\n\nTo upgrade, run::\n\n pip install --upgrade infomap\n\n\nWhen the Python package is installed, an executable called\n``infomap`` (with lowercase i) is available from any directory.\n\nTo get started, read `Infomap Python API`_.\n\n.. _`Infomap Python API`: https://mapequation.github.io/infomap/python/\n\nUsing Docker\n------------\n\nThere are currently two Docker images available on `Docker Hub`_.\n\n- ``mapequation/infomap``\n- ``mapequation/infomap:notebook`` based on ``jupyter/scipy-notebook``\n\nThe image ``mapequation/infomap`` can be started with\n\n.. code-block:: bash\n\n docker run -it --rm \\\n -v `pwd`:/data \\\n mapequation/infomap\n [infomap arguments]\n\nYou can also use the supplied `docker-compose.yml`_:\n\n.. code-block:: bash\n\n docker-compose run --rm infomap\n\nThe image ``mapequation/infomap:notebook`` can be started with\n\n.. code-block:: bash\n\n docker run \\\n -v `pwd`:/home/jovyan/work \\\n -p 8888:8888 \\\n mapequation/infomap:notebook \\\n start.sh jupyter lab\n\nOr similarly, using docker-compose:\n\n.. code-block:: bash\n\n docker-compose up notebook\n\n.. _`Docker Hub`: https://hub.docker.com/r/mapequation/infomap\n.. _`docker-compose.yml`: https://github.com/mapequation/infomap/blob/master/docker-compose.yml\n\nCompiling from source\n---------------------\n\nInstalling Infomap from source requires a working ``gcc`` or ``clang`` compiler.\n\nTo download and compile the newest version from `Github`_, clone the repository\nby running\n\n.. code-block:: shell\n\n git clone git@github.com:mapequation/infomap.git\n cd infomap\n make\n\nThis creates the binary ``Infomap``, run it using::\n\n ./Infomap [options] network_data destination\n\nFor a list of options, run::\n\n ./Infomap --help\n\nRead `the documentation`_ to learn more about the different options.\n\n.. _Github: https://www.github.com/mapequation/infomap\n.. _the documentation: https://www.mapequation.org/infomap\n\nNpm package\n-----------\n\nAn experimental Javascript web worker is available on `NPM`_.\n\nTo install it, run\n\n.. code-block:: shell\n\n npm install @mapequation/infomap\n\n.. _NPM: https://www.npmjs.com/package/@mapequation/infomap\n\nFeedback\n--------\n\nIf you have any questions, suggestions or issues regarding the software,\nplease add them to `GitHub issues`_.\n\n.. _Github issues: http://www.github.com/mapequation/infomap/issues\n\nAuthors\n-------\n\nDaniel Edler, Anton Holmgren, Martin Rosvall\n\nFor contact information, see `mapequation.org/about.html`_.\n\n.. _`mapequation.org/about.html`: https://www.mapequation.org/about.html\n\nTerms of use\n------------\n\nInfomap is released under a dual licence.\n\nTo give everyone maximum freedom to make use of Infomap\nand derivative works, we make the code open source under\nthe GNU Affero General Public License version 3 or any\nlater version (see `LICENSE_AGPLv3.txt`_).\n\nFor a non-copyleft license, please contact us.\n\n.. _LICENSE_AGPLv3.txt: https://github.com/mapequation/infomap/blob/master/LICENSE_AGPLv3.txt\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "Infomap network clustering algorithm",
"version": "2.7.1",
"split_keywords": [
"map-equation",
"network-analysis",
"community-detection",
"clustering-algorithm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f332c71f0f6963b7d5b71ae0fb31d70354eff9916dd68eb1a5425191ed59a8ce",
"md5": "60bc6a8c4b040af93a5bbaa47107d56e",
"sha256": "167f87da8b72d22dea9c3c6d5245fe5c45a60e68579f729edb7aa5bcb7325e21"
},
"downloads": -1,
"filename": "infomap-2.7.1-cp310-cp310-macosx_11_0_x86_64.whl",
"has_sig": false,
"md5_digest": "60bc6a8c4b040af93a5bbaa47107d56e",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3",
"size": 715206,
"upload_time": "2023-04-25T19:17:37",
"upload_time_iso_8601": "2023-04-25T19:17:37.691117Z",
"url": "https://files.pythonhosted.org/packages/f3/32/c71f0f6963b7d5b71ae0fb31d70354eff9916dd68eb1a5425191ed59a8ce/infomap-2.7.1-cp310-cp310-macosx_11_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "07fea65690be53ac967cf038e4a84379433fed7068611aad37fc8f5e6fd5c79b",
"md5": "01e7274ff476131af84f594b70ae48f9",
"sha256": "6e9369e43d8347c3b141abb6b060e8fd4bcef89a676a98b7109d37c29d798563"
},
"downloads": -1,
"filename": "infomap-2.7.1-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "01e7274ff476131af84f594b70ae48f9",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3",
"size": 561965,
"upload_time": "2023-04-25T19:17:40",
"upload_time_iso_8601": "2023-04-25T19:17:40.282478Z",
"url": "https://files.pythonhosted.org/packages/07/fe/a65690be53ac967cf038e4a84379433fed7068611aad37fc8f5e6fd5c79b/infomap-2.7.1-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4d24291671127f3cb7d8fcf399bcda557a746581998ce81ab8e120d2242159b",
"md5": "8acc199bb27ddce0c4a17ebec87bee05",
"sha256": "188ad76d3b7087224498326977e8711ebcc9526738d4a79d2d8ed5c166688207"
},
"downloads": -1,
"filename": "infomap-2.7.1-cp37-cp37m-macosx_10_15_x86_64.whl",
"has_sig": false,
"md5_digest": "8acc199bb27ddce0c4a17ebec87bee05",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3",
"size": 719715,
"upload_time": "2023-04-25T19:17:42",
"upload_time_iso_8601": "2023-04-25T19:17:42.158480Z",
"url": "https://files.pythonhosted.org/packages/c4/d2/4291671127f3cb7d8fcf399bcda557a746581998ce81ab8e120d2242159b/infomap-2.7.1-cp37-cp37m-macosx_10_15_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0582cb268b2d43a087861f9bb82b7138f26d60983c734933f33811bfb49f6c01",
"md5": "e9184f0d8926c83b2209335270733195",
"sha256": "52aba7e9df564c8a05d5c48bf12626b892ac5e9e5fc519cbd100a8f705b4528e"
},
"downloads": -1,
"filename": "infomap-2.7.1-cp37-cp37m-win_amd64.whl",
"has_sig": false,
"md5_digest": "e9184f0d8926c83b2209335270733195",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3",
"size": 605829,
"upload_time": "2023-04-25T19:17:44",
"upload_time_iso_8601": "2023-04-25T19:17:44.399808Z",
"url": "https://files.pythonhosted.org/packages/05/82/cb268b2d43a087861f9bb82b7138f26d60983c734933f33811bfb49f6c01/infomap-2.7.1-cp37-cp37m-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "026e4b3ab6fa202b04eb68baa87761501a2e5e6436cd0522dff0fdf9f2438b2d",
"md5": "b2efdccd2adf6cac15d35845e7855bc9",
"sha256": "a0371c09f06f0562eaa497204c8c5276a06b2c4d8fb466e850fff53c9e0ca02c"
},
"downloads": -1,
"filename": "infomap-2.7.1-cp38-cp38-macosx_10_15_x86_64.whl",
"has_sig": false,
"md5_digest": "b2efdccd2adf6cac15d35845e7855bc9",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3",
"size": 720322,
"upload_time": "2023-04-25T19:17:46",
"upload_time_iso_8601": "2023-04-25T19:17:46.228454Z",
"url": "https://files.pythonhosted.org/packages/02/6e/4b3ab6fa202b04eb68baa87761501a2e5e6436cd0522dff0fdf9f2438b2d/infomap-2.7.1-cp38-cp38-macosx_10_15_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a2035e4417bbcba06988e1a79dca962c928ad1fb95ff7fda51564fcd66961812",
"md5": "f8ee942e29b58318f77a631e605101e6",
"sha256": "85d4fe148693ca5dca03d5069836eda535c0246abf2f175c2e418fa5dc47fb93"
},
"downloads": -1,
"filename": "infomap-2.7.1-cp38-cp38-win_amd64.whl",
"has_sig": false,
"md5_digest": "f8ee942e29b58318f77a631e605101e6",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3",
"size": 606785,
"upload_time": "2023-04-25T19:17:49",
"upload_time_iso_8601": "2023-04-25T19:17:49.169753Z",
"url": "https://files.pythonhosted.org/packages/a2/03/5e4417bbcba06988e1a79dca962c928ad1fb95ff7fda51564fcd66961812/infomap-2.7.1-cp38-cp38-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ccbb9bfbaaa8bc68fccdc687bfab328e80d4c12c66e70956e3d88ca543b87e79",
"md5": "7c235f5276cb1b8ab4ee8001967fe04a",
"sha256": "37b91d20610c3ff089eef418a058635f805f1239e2fd8859cce22219059041b6"
},
"downloads": -1,
"filename": "infomap-2.7.1-cp39-cp39-macosx_11_0_x86_64.whl",
"has_sig": false,
"md5_digest": "7c235f5276cb1b8ab4ee8001967fe04a",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3",
"size": 715227,
"upload_time": "2023-04-25T19:17:52",
"upload_time_iso_8601": "2023-04-25T19:17:52.507055Z",
"url": "https://files.pythonhosted.org/packages/cc/bb/9bfbaaa8bc68fccdc687bfab328e80d4c12c66e70956e3d88ca543b87e79/infomap-2.7.1-cp39-cp39-macosx_11_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c0005ff34d5f0fdd8f6410b34ba3850786af5e60b523540c631bb59e2388a3a5",
"md5": "1471fa148e744725cabb1db2d5035eb8",
"sha256": "b65a48614a33c37a4d671d04378cb4147e99468d0cbf945568bee05b148058df"
},
"downloads": -1,
"filename": "infomap-2.7.1-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "1471fa148e744725cabb1db2d5035eb8",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3",
"size": 608596,
"upload_time": "2023-04-25T19:17:56",
"upload_time_iso_8601": "2023-04-25T19:17:56.846675Z",
"url": "https://files.pythonhosted.org/packages/c0/00/5ff34d5f0fdd8f6410b34ba3850786af5e60b523540c631bb59e2388a3a5/infomap-2.7.1-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cebb32a2f3bbea80407ec1af1d0730d8d46208f8be0bb797d0e1d1e4da4128e4",
"md5": "85581ed9c880a385721a711fb4b3dc41",
"sha256": "e23d52dffdb68646fcdcd9c7c7a6760ec26038c21107c47336604ee66ea74c18"
},
"downloads": -1,
"filename": "infomap-2.7.1.tar.gz",
"has_sig": false,
"md5_digest": "85581ed9c880a385721a711fb4b3dc41",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 263117,
"upload_time": "2023-04-25T19:17:59",
"upload_time_iso_8601": "2023-04-25T19:17:59.550874Z",
"url": "https://files.pythonhosted.org/packages/ce/bb/32a2f3bbea80407ec1af1d0730d8d46208f8be0bb797d0e1d1e4da4128e4/infomap-2.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-25 19:17:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "infomap"
}
JSON