@mapequation/infomap
v2.10.1
Published
Infomap network clustering algorithm
Readme
@mapequation/infomap
@mapequation/infomap packages Infomap as a browser web worker built with
Emscripten.
Infomap is a network clustering algorithm based on the Map equation. The package is used in Infomap Online.
Install
npm install @mapequation/infomapUse with ES modules
import Infomap from "@mapequation/infomap";
const network = `#source target [weight]
0 1
0 2
0 3
1 0
1 2
2 1
2 0
3 0
3 4
3 5
4 3
4 5
5 4
5 3`;
const infomap = new Infomap()
.on("data", (data) => console.log(data))
.on("error", (error) => console.warn(error))
.on("finished", (data) => console.log(data));
infomap.run({
network,
args: {
twoLevel: true,
},
});React users can import the hook entrypoint directly from the main package:
import { useInfomap } from "@mapequation/infomap/react";Use from a CDN
With JSDelivr, the package is available as window.infomap.default.
<!doctype html>
<html>
<head>
<script src="https://cdn.jsdelivr.net/npm/@mapequation/infomap@latest/index.umd.js"></script>
</head>
<body>
<script>
const Infomap = window.infomap.default;
const network = "#--- same network as above ---";
const infomap = new Infomap()
.on("data", (data) => console.log(data))
.on("error", (error) => console.warn(error))
.on("finished", (data) => console.log(data));
infomap.run({
network,
args: {
twoLevel: true,
},
});
</script>
</body>
</html>Package notes
@mapequation/infomap/reactis the supported React entrypoint.
More information
- Main docs: mapequation.org/infomap
- Issues: github.com/mapequation/infomap/issues
Authors
Daniel Edler, Anton Holmgren, Martin Rosvall
Contact details are available at mapequation.org/about.html.
Terms of use
Infomap is released under a dual licence.
The code is available under the GNU General Public License version 3 or any
later version; see LICENSE_GPLv3.txt.
For a non-copyleft license, please contact us.