First commit on github -- NetBunch 1.0

author: KatolaZ <katolaz@freaknet.org> 2017-09-27 15:06:31 +0100
committer: KatolaZ <katolaz@freaknet.org> 2017-09-27 15:06:31 +0100
commit: 3aee2fd43e3059a699af2b63c6f2395e5a55e515 (patch)
tree: 58c95505a0906ed9cfa694f9dbd319403fd8f01d /doc/modularity.1.html
1 files changed, 151 insertions, 0 deletions
diff --git a/doc/modularity.1.html b/doc/modularity.1.html
new file mode 100644
index 0000000..a6d4242
--- /dev/null
+++ b/doc/modularity.1.html
@@ -0,0 +1,151 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>modularity(1) - Compute the modularity of a partition of a graph</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+  <style type='text/css' media='all'>
+  /* style: toc */
+  .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
+  .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
+  .man-navigation a:hover {color:#111;text-decoration:underline}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#PARAMETERS">PARAMETERS</a>
+    <a href="#INPUT-FORMAT">INPUT FORMAT</a>
+    <a href="#OUTPUT">OUTPUT</a>
+    <a href="#REFERENCES">REFERENCES</a>
+    <a href="#AUTHORS">AUTHORS</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>modularity(1)</li>
+    <li class='tc'>www.complex-networks.net</li>
+    <li class='tr'>modularity(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>modularity</code> - <span class="man-whatis">Compute the modularity of a partition of a graph</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>modularity</code> <var>graph_in</var> <var>partition</var></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p><code>modularity</code> computes the value of the modularity function associated
+to a partition of the nodes of the graph given as input.</p>
+
+<h2 id="PARAMETERS">PARAMETERS</h2>
+
+<dl>
+<dt><var>graph_in</var></dt><dd><p>  undirected input graph (edge list). If is equal to <code>-</code> (dash), read
+  the edge list from STDIN.</p></dd>
+<dt><var>partition</var></dt><dd><p>  The name of the file containing the association of nodes to
+  communities (the partition of which one wants to compute the
+  modularity). See <a href="#INPUT-FORMAT" title="INPUT FORMAT" data-bare-link="true">INPUT FORMAT</a> for details.</p></dd>
+</dl>
+
+
+<h2 id="INPUT-FORMAT">INPUT FORMAT</h2>
+
+<p><var>graph_in</var> is an edge-list. The file <var>partition</var> is in the format:</p>
+
+<pre><code>    node_0 community_0
+    node_1 community_1
+    ....
+</code></pre>
+
+<p>where 'node_0' is the label of the first node and 'community_0' is the
+community to which 'node_0' belongs, and so on.</p>
+
+<h2 id="OUTPUT">OUTPUT</h2>
+
+<p><code>modularity</code> prints on STDOUT the value of the modularity function
+associated to the partition of the graph provided as input. The
+program also prints on STDERR one line in the format:</p>
+
+<pre><code>    ## nc: NUM_COMMUNITIES
+</code></pre>
+
+<p>where 'NUM_COMMUNITIES' is the number of communities in the partition
+provided as input.</p>
+
+<h2 id="REFERENCES">REFERENCES</h2>
+
+<ul>
+<li><p>M. E. J. Newman and M. Girvan. "Finding and evaluating community
+structure in networks". Phys. Rev. E 69, (2004), 026113.</p></li>
+<li><p>V. Latora, V. Nicosia, G. Russo, "Complex Networks: Principles,
+Methods and Applications", Chapter 9, Cambridge University Press
+(2017)</p></li>
+</ul>
+
+
+<h2 id="AUTHORS">AUTHORS</h2>
+
+<p>(c) Vincenzo 'KatolaZ' Nicosia 2009-2017 <code>&lt;v.nicosia@qmul.ac.uk&gt;</code>.</p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'>www.complex-networks.net</li>
+    <li class='tc'>September 2017</li>
+    <li class='tr'>modularity(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>
author	KatolaZ <katolaz@freaknet.org>	2017-09-27 15:06:31 +0100
committer	KatolaZ <katolaz@freaknet.org>	2017-09-27 15:06:31 +0100
commit	3aee2fd43e3059a699af2b63c6f2395e5a55e515 (patch)
tree	58c95505a0906ed9cfa694f9dbd319403fd8f01d /doc/modularity.1.html