add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / util / netgraph.html
diff --git a/doc/sphinx/_build/html/_modules/nepi/util/netgraph.html b/doc/sphinx/_build/html/_modules/nepi/util/netgraph.html
new file mode 100644 (file)
index 0000000..c1c5ad8
--- /dev/null
@@ -0,0 +1,434 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>nepi.util.netgraph &mdash; NEPI 3.0 documentation</title>
+    
+    <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
+    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../../',
+        VERSION:     '3.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../../_static/doctools.js"></script>
+    <link rel="top" title="NEPI 3.0 documentation" href="../../../index.html" />
+    <link rel="up" title="Module code" href="../../index.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
+          <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li> 
+      </ul>
+    </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <h1>Source code for nepi.util.netgraph</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c">#    NEPI, a framework to manage network experiments</span>
+<span class="c">#    Copyright (C) 2013 INRIA</span>
+<span class="c">#</span>
+<span class="c">#    This program is free software: you can redistribute it and/or modify</span>
+<span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
+<span class="c">#    published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c">#    This program is distributed in the hope that it will be useful,</span>
+<span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
+<span class="c">#    GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c">#    You should have received a copy of the GNU General Public License</span>
+<span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
+<span class="c">#</span>
+<span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
+
+<span class="kn">import</span> <span class="nn">ipaddr</span>
+<span class="kn">import</span> <span class="nn">networkx</span>
+<span class="kn">import</span> <span class="nn">math</span>
+<span class="kn">import</span> <span class="nn">random</span>
+
+<div class="viewcode-block" id="TopologyType"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.TopologyType">[docs]</a><span class="k">class</span> <span class="nc">TopologyType</span><span class="p">:</span>
+    <span class="n">LINEAR</span> <span class="o">=</span> <span class="s">&quot;linear&quot;</span>
+    <span class="n">LADDER</span> <span class="o">=</span> <span class="s">&quot;ladder&quot;</span>
+    <span class="n">MESH</span> <span class="o">=</span> <span class="s">&quot;mesh&quot;</span>
+    <span class="n">TREE</span> <span class="o">=</span> <span class="s">&quot;tree&quot;</span>
+    <span class="n">STAR</span> <span class="o">=</span> <span class="s">&quot;star&quot;</span>
+    <span class="n">ADHOC</span> <span class="o">=</span> <span class="s">&quot;adhoc&quot;</span>
+
+<span class="c">## TODO: </span>
+<span class="c">##      - AQ: Add support for hypergraphs (to be able to add hyper edges to </span>
+<span class="c">##        model CSMA or wireless networks)</span>
+</div>
+<div class="viewcode-block" id="NetGraph"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph">[docs]</a><span class="k">class</span> <span class="nc">NetGraph</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot; NetGraph represents a network topology. </span>
+<span class="sd">    Network graphs are internally using the networkx library.</span>
+
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; A graph can be generated using a specified pattern </span>
+<span class="sd">        (LADDER, MESH, TREE, etc), or provided as an argument.</span>
+
+<span class="sd">            :param topology: Undirected graph to use as internal representation </span>
+<span class="sd">            :type topology: networkx.Graph</span>
+
+<span class="sd">            :param topo_type: One of TopologyType.{LINEAR,LADDER,MESH,TREE,STAR}</span>
+<span class="sd">            used to automatically generate the topology graph. </span>
+<span class="sd">            :type topo_type: TopologyType</span>
+
+<span class="sd">            :param node_count: Number of nodes in the topology to be generated. </span>
+<span class="sd">            :type node_count: int</span>
+
+<span class="sd">            :param branches: Number of branches (arms) for the STAR topology. </span>
+<span class="sd">            :type branches: int</span>
+
+
+<span class="sd">            :param assign_ips: Automatically assign IP addresses to each node. </span>
+<span class="sd">            :type assign_ips: bool</span>
+
+<span class="sd">            :param network: Base network segment for IP address assignment.</span>
+<span class="sd">            :type network: str</span>
+
+<span class="sd">            :param prefix: Base network prefix for IP address assignment.</span>
+<span class="sd">            :type prefix: int</span>
+
+<span class="sd">            :param version: IP version for IP address assignment.</span>
+<span class="sd">            :type version: int</span>
+
+<span class="sd">            :param assign_st: Select source and target nodes on the graph.</span>
+<span class="sd">            :type assign_st: bool</span>
+
+<span class="sd">          :param sources_targets: dictionary with the list of sources (key =</span>
+<span class="sd">            &quot;sources&quot;) and list of targets (key = &quot;targets&quot;) if defined, ignore</span>
+<span class="sd">            assign_st</span>
+<span class="sd">          :type sources_targets: dictionary of lists</span>
+
+<span class="sd">          :param leaf_source: if True, random sources will be selected only </span>
+<span class="sd">            from leaf nodes.</span>
+<span class="sd">          :type leaf_source: bool</span>
+
+<span class="sd">        NOTE: Only point-to-point like network topologies are supported for now.</span>
+<span class="sd">                (Wireless and Ethernet networks were several nodes share the same</span>
+<span class="sd">                edge (hyperedge) can not be modeled for the moment).</span>
+
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_topology</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;topology&quot;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_topo_type</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;topo_type&quot;</span><span class="p">,</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">ADHOC</span><span class="p">)</span>
+
+        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="p">:</span>
+            <span class="k">if</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;node_count&quot;</span><span class="p">):</span>
+                <span class="n">node_count</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s">&quot;node_count&quot;</span><span class="p">]</span>
+                <span class="n">branches</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;branches&quot;</span><span class="p">)</span>
+
+                <span class="bp">self</span><span class="o">.</span><span class="n">_topology</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">generate_topology</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">topo_type</span><span class="p">,</span> 
+                        <span class="n">node_count</span><span class="p">,</span> <span class="n">branches</span> <span class="o">=</span> <span class="n">branches</span><span class="p">)</span>
+            <span class="k">else</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">_topology</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">Graph</span><span class="p">()</span>
+
+        <span class="k">if</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;assign_ips&quot;</span><span class="p">):</span>
+            <span class="n">network</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;network&quot;</span><span class="p">,</span> <span class="s">&quot;10.0.0.0&quot;</span><span class="p">)</span>
+            <span class="n">prefix</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;prefix&quot;</span><span class="p">,</span> <span class="mi">8</span><span class="p">)</span>
+            <span class="n">version</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;version&quot;</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
+
+            <span class="bp">self</span><span class="o">.</span><span class="n">assign_p2p_ips</span><span class="p">(</span><span class="n">network</span> <span class="o">=</span> <span class="n">network</span><span class="p">,</span> <span class="n">prefix</span> <span class="o">=</span> <span class="n">prefix</span><span class="p">,</span> 
+                    <span class="n">version</span> <span class="o">=</span> <span class="n">version</span><span class="p">)</span>
+
+       <span class="n">sources_targets</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;sources_targets&quot;</span><span class="p">)</span>
+       <span class="k">if</span> <span class="n">sources_targets</span><span class="p">:</span>
+            <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">set_source</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">sources_targets</span><span class="p">[</span><span class="s">&quot;sources&quot;</span><span class="p">]]</span>
+           <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">set_target</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">sources_targets</span><span class="p">[</span><span class="s">&quot;targets&quot;</span><span class="p">]]</span>
+       <span class="k">elif</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;assign_st&quot;</span><span class="p">):</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">select_target_zero</span><span class="p">()</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">select_random_source</span><span class="p">(</span><span class="n">is_leaf</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;leaf_source&quot;</span><span class="p">))</span>
+
+    <span class="nd">@property</span>
+<div class="viewcode-block" id="NetGraph.topology"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.topology">[docs]</a>    <span class="k">def</span> <span class="nf">topology</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_topology</span>
+</div>
+    <span class="nd">@property</span>
+<div class="viewcode-block" id="NetGraph.topo_type"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.topo_type">[docs]</a>    <span class="k">def</span> <span class="nf">topo_type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_topo_type</span>
+</div>
+    <span class="nd">@property</span>
+<div class="viewcode-block" id="NetGraph.order"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.order">[docs]</a>    <span class="k">def</span> <span class="nf">order</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">order</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="NetGraph.nodes"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.nodes">[docs]</a>    <span class="k">def</span> <span class="nf">nodes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">nodes</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="NetGraph.edges"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.edges">[docs]</a>    <span class="k">def</span> <span class="nf">edges</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edges</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="NetGraph.generate_topology"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.generate_topology">[docs]</a>    <span class="k">def</span> <span class="nf">generate_topology</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">topo_type</span><span class="p">,</span> <span class="n">node_count</span><span class="p">,</span> <span class="n">branches</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+        <span class="k">if</span> <span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">LADDER</span><span class="p">:</span>
+            <span class="n">total_nodes</span> <span class="o">=</span> <span class="n">node_count</span><span class="o">/</span><span class="mi">2</span>
+            <span class="n">graph</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">ladder_graph</span><span class="p">(</span><span class="n">total_nodes</span><span class="p">)</span>
+
+        <span class="k">elif</span> <span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">LINEAR</span><span class="p">:</span>
+            <span class="n">graph</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">path_graph</span><span class="p">(</span><span class="n">node_count</span><span class="p">)</span>
+
+        <span class="k">elif</span> <span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">MESH</span><span class="p">:</span>
+            <span class="n">graph</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">complete_graph</span><span class="p">(</span><span class="n">node_count</span><span class="p">)</span>
+
+        <span class="k">elif</span> <span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">TREE</span><span class="p">:</span>
+            <span class="n">h</span> <span class="o">=</span> <span class="n">math</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">node_count</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span><span class="o">/</span><span class="n">math</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span>
+            <span class="n">graph</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">balanced_tree</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="n">h</span><span class="p">)</span>
+
+        <span class="k">elif</span> <span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">STAR</span><span class="p">:</span>
+            <span class="n">graph</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">Graph</span><span class="p">()</span>
+            <span class="n">graph</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+
+            <span class="n">nodesinbranch</span> <span class="o">=</span> <span class="p">(</span><span class="n">node_count</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span><span class="o">/</span> <span class="n">BRANCHES</span>
+            <span class="n">c</span> <span class="o">=</span> <span class="mi">1</span>
+
+            <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="n">BRANCHES</span><span class="p">):</span>
+                <span class="n">prev</span> <span class="o">=</span> <span class="mi">0</span>
+                <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">nodesinbranch</span> <span class="o">+</span> <span class="mi">1</span><span class="p">):</span>
+                    <span class="n">graph</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
+                    <span class="n">graph</span><span class="o">.</span><span class="n">add_edge</span><span class="p">(</span><span class="n">prev</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span>
+                    <span class="n">prev</span> <span class="o">=</span> <span class="n">c</span>
+                    <span class="n">c</span> <span class="o">+=</span> <span class="mi">1</span>
+
+        <span class="k">return</span> <span class="n">graph</span>
+</div>
+<div class="viewcode-block" id="NetGraph.add_node"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.add_node">[docs]</a>    <span class="k">def</span> <span class="nf">add_node</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
+        <span class="k">if</span> <span class="n">nid</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="p">:</span> 
+            <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="n">nid</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="NetGraph.add_edge"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.add_edge">[docs]</a>    <span class="k">def</span> <span class="nf">add_edge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="n">nid1</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span> <span class="n">nid2</span><span class="p">)</span>
+
+        <span class="k">if</span> <span class="n">nid1</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="p">[</span><span class="n">nid2</span><span class="p">]:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">add_edge</span><span class="p">(</span><span class="n">nid2</span><span class="p">,</span> <span class="n">nid1</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="NetGraph.annotate_node_ip"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.annotate_node_ip">[docs]</a>    <span class="k">def</span> <span class="nf">annotate_node_ip</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">,</span> <span class="n">ip</span><span class="p">):</span>
+        <span class="k">if</span> <span class="s">&quot;ips&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="s">&quot;ips&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="s">&quot;ips&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ip</span><span class="p">)</span>
+ </div>
+<div class="viewcode-block" id="NetGraph.node_ip_annotations"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.node_ip_annotations">[docs]</a>    <span class="k">def</span> <span class="nf">node_ip_annotations</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;ips&quot;</span><span class="p">,</span> <span class="p">[])</span>
+   </div>
+<div class="viewcode-block" id="NetGraph.annotate_node"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.annotate_node">[docs]</a>    <span class="k">def</span> <span class="nf">annotate_node</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span> <span class="ow">and</span> \
+                <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">float</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
+            <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">&quot;Non-serializable annotation&quot;</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
+    </div>
+<div class="viewcode-block" id="NetGraph.node_annotation"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.node_annotation">[docs]</a>    <span class="k">def</span> <span class="nf">node_annotation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="NetGraph.node_annotations"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.node_annotations">[docs]</a>    <span class="k">def</span> <span class="nf">node_annotations</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
+    </div>
+<div class="viewcode-block" id="NetGraph.del_node_annotation"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.del_node_annotation">[docs]</a>    <span class="k">def</span> <span class="nf">del_node_annotation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+        <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="n">name</span><span class="p">]</span>
+</div>
+<div class="viewcode-block" id="NetGraph.annotate_edge"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.annotate_edge">[docs]</a>    <span class="k">def</span> <span class="nf">annotate_edge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span> <span class="ow">and</span> \
+                <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">float</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
+            <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">&quot;Non-serializable annotation&quot;</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
+   </div>
+<div class="viewcode-block" id="NetGraph.annotate_edge_net"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.annotate_edge_net">[docs]</a>    <span class="k">def</span> <span class="nf">annotate_edge_net</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">,</span> <span class="n">ip1</span><span class="p">,</span> <span class="n">ip2</span><span class="p">,</span> <span class="n">mask</span><span class="p">,</span> <span class="n">network</span><span class="p">,</span> 
+            <span class="n">prefixlen</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">][</span><span class="n">nid1</span><span class="p">]</span> <span class="o">=</span> <span class="n">ip1</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">][</span><span class="n">nid2</span><span class="p">]</span> <span class="o">=</span> <span class="n">ip2</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">][</span><span class="s">&quot;mask&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">mask</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">][</span><span class="s">&quot;network&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">network</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">][</span><span class="s">&quot;prefix&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">prefixlen</span>
+</div>
+<div class="viewcode-block" id="NetGraph.edge_net_annotation"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.edge_net_annotation">[docs]</a>    <span class="k">def</span> <span class="nf">edge_net_annotation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;net&quot;</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
+ </div>
+<div class="viewcode-block" id="NetGraph.edge_annotation"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.edge_annotation">[docs]</a>    <span class="k">def</span> <span class="nf">edge_annotation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
+ </div>
+<div class="viewcode-block" id="NetGraph.edge_annotations"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.edge_annotations">[docs]</a>    <span class="k">def</span> <span class="nf">edge_annotations</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
+    </div>
+<div class="viewcode-block" id="NetGraph.del_edge_annotation"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.del_edge_annotation">[docs]</a>    <span class="k">def</span> <span class="nf">del_edge_annotation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+        <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="n">name</span><span class="p">]</span>
+</div>
+<div class="viewcode-block" id="NetGraph.assign_p2p_ips"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.assign_p2p_ips">[docs]</a>    <span class="k">def</span> <span class="nf">assign_p2p_ips</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">network</span> <span class="o">=</span> <span class="s">&quot;10.0.0.0&quot;</span><span class="p">,</span> <span class="n">prefix</span> <span class="o">=</span> <span class="mi">8</span><span class="p">,</span> <span class="n">version</span> <span class="o">=</span> <span class="mi">4</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; Assign IP addresses to each end of each edge of the network graph,</span>
+<span class="sd">        computing all the point to point subnets and addresses in the network</span>
+<span class="sd">        representation.</span>
+
+<span class="sd">            :param network: Base network address used for subnetting. </span>
+<span class="sd">            :type network: str</span>
+
+<span class="sd">            :param prefix: Prefix for the base network address used for subnetting.</span>
+<span class="sd">            :type prefixt: int</span>
+
+<span class="sd">            :param version: IP version (either 4 or 6).</span>
+<span class="sd">            :type version: int</span>
+
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="n">networkx</span><span class="o">.</span><span class="n">number_connected_components</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Disconnected graph!!&quot;</span><span class="p">)</span>
+
+        <span class="c"># Assign IP addresses to host</span>
+        <span class="n">netblock</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">/</span><span class="si">%d</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">prefix</span><span class="p">)</span>
+        <span class="k">if</span> <span class="n">version</span> <span class="o">==</span> <span class="mi">4</span><span class="p">:</span>
+            <span class="n">net</span> <span class="o">=</span> <span class="n">ipaddr</span><span class="o">.</span><span class="n">IPv4Network</span><span class="p">(</span><span class="n">netblock</span><span class="p">)</span>
+            <span class="n">new_prefix</span> <span class="o">=</span> <span class="mi">30</span>
+        <span class="k">elif</span> <span class="n">version</span> <span class="o">==</span> <span class="mi">6</span><span class="p">:</span>
+            <span class="n">net</span> <span class="o">=</span> <span class="n">ipaddr</span><span class="o">.</span><span class="n">IPv6Network</span><span class="p">(</span><span class="n">netblock</span><span class="p">)</span>
+            <span class="n">new_prefix</span> <span class="o">=</span> <span class="mi">30</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">&quot;Invalid IP version </span><span class="si">%d</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">version</span>
+        
+        <span class="c">## Clear all previusly assigned IPs</span>
+        <span class="k">for</span> <span class="n">nid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">nodes</span><span class="p">():</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="s">&quot;ips&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+
+        <span class="c">## Generate and assign new IPs</span>
+        <span class="n">sub_itr</span> <span class="o">=</span> <span class="n">net</span><span class="o">.</span><span class="n">iter_subnets</span><span class="p">(</span><span class="n">new_prefix</span> <span class="o">=</span> <span class="n">new_prefix</span><span class="p">)</span>
+        
+        <span class="k">for</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edges</span><span class="p">():</span>
+            <span class="c">#### Compute subnets for each link</span>
+            
+            <span class="c"># get a subnet of base_add with prefix /30</span>
+            <span class="n">subnet</span> <span class="o">=</span> <span class="n">sub_itr</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
+            <span class="n">mask</span> <span class="o">=</span> <span class="n">subnet</span><span class="o">.</span><span class="n">netmask</span><span class="o">.</span><span class="n">exploded</span>
+            <span class="n">network</span> <span class="o">=</span> <span class="n">subnet</span><span class="o">.</span><span class="n">network</span><span class="o">.</span><span class="n">exploded</span>
+            <span class="n">prefixlen</span> <span class="o">=</span> <span class="n">subnet</span><span class="o">.</span><span class="n">prefixlen</span>
+
+            <span class="c"># get host addresses in that subnet</span>
+            <span class="n">i</span> <span class="o">=</span> <span class="n">subnet</span><span class="o">.</span><span class="n">iterhosts</span><span class="p">()</span>
+            <span class="n">addr1</span> <span class="o">=</span> <span class="n">i</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
+            <span class="n">addr2</span> <span class="o">=</span> <span class="n">i</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
+
+            <span class="n">ip1</span> <span class="o">=</span> <span class="n">addr1</span><span class="o">.</span><span class="n">exploded</span>
+            <span class="n">ip2</span> <span class="o">=</span> <span class="n">addr2</span><span class="o">.</span><span class="n">exploded</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">annotate_edge_net</span><span class="p">(</span><span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">,</span> <span class="n">ip1</span><span class="p">,</span> <span class="n">ip2</span><span class="p">,</span> <span class="n">mask</span><span class="p">,</span> <span class="n">network</span><span class="p">,</span> 
+                    <span class="n">prefixlen</span><span class="p">)</span>
+
+            <span class="bp">self</span><span class="o">.</span><span class="n">annotate_node_ip</span><span class="p">(</span><span class="n">nid1</span><span class="p">,</span> <span class="n">ip1</span><span class="p">)</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">annotate_node_ip</span><span class="p">(</span><span class="n">nid2</span><span class="p">,</span> <span class="n">ip2</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="NetGraph.get_p2p_info"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.get_p2p_info">[docs]</a>    <span class="k">def</span> <span class="nf">get_p2p_info</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">):</span>
+        <span class="n">net</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">]</span>
+        <span class="k">return</span> <span class="p">(</span> <span class="n">net</span><span class="p">[</span><span class="n">nid1</span><span class="p">],</span> <span class="n">net</span><span class="p">[</span><span class="n">nid2</span><span class="p">],</span> <span class="n">net</span><span class="p">[</span><span class="s">&quot;mask&quot;</span><span class="p">],</span> <span class="n">net</span><span class="p">[</span><span class="s">&quot;network&quot;</span><span class="p">],</span> 
+                <span class="n">net</span><span class="p">[</span><span class="s">&quot;prefixlen&quot;</span><span class="p">]</span> <span class="p">)</span>
+</div>
+<div class="viewcode-block" id="NetGraph.set_source"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.set_source">[docs]</a>    <span class="k">def</span> <span class="nf">set_source</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="s">&quot;source&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">True</span>
+</div>
+<div class="viewcode-block" id="NetGraph.is_source"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.is_source">[docs]</a>    <span class="k">def</span> <span class="nf">is_source</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;source&quot;</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="NetGraph.set_target"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.set_target">[docs]</a>    <span class="k">def</span> <span class="nf">set_target</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="s">&quot;target&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">True</span>
+</div>
+<div class="viewcode-block" id="NetGraph.is_target"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.is_target">[docs]</a>    <span class="k">def</span> <span class="nf">is_target</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;target&quot;</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="NetGraph.targets"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.targets">[docs]</a>    <span class="k">def</span> <span class="nf">targets</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; Returns the nodes that are targets &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="p">[</span><span class="n">nid</span> <span class="k">for</span> <span class="n">nid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">nodes</span><span class="p">()</span> \
+                <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;target&quot;</span><span class="p">)]</span>
+</div>
+<div class="viewcode-block" id="NetGraph.sources"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.sources">[docs]</a>    <span class="k">def</span> <span class="nf">sources</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; Returns the nodes that are sources &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="p">[</span><span class="n">nid</span> <span class="k">for</span> <span class="n">nid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">nodes</span><span class="p">()</span> \
+                <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;source&quot;</span><span class="p">)]</span>
+</div>
+<div class="viewcode-block" id="NetGraph.select_target_zero"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.select_target_zero">[docs]</a>    <span class="k">def</span> <span class="nf">select_target_zero</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; Mark the node 0 as target</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">nid</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">if</span> <span class="mi">0</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">nodes</span><span class="p">()</span> <span class="k">else</span> <span class="s">&quot;0&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">set_target</span><span class="p">(</span><span class="n">nid</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="NetGraph.select_random_source"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.select_random_source">[docs]</a>    <span class="k">def</span> <span class="nf">select_random_source</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;  Mark a random node as source. </span>
+<span class="sd">        &quot;&quot;&quot;</span>
+
+        <span class="c"># The ladder is a special case because is not symmetric.</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">LADDER</span><span class="p">:</span>
+            <span class="n">total_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">order</span><span class="o">/</span><span class="mi">2</span>
+            <span class="n">leaf1</span> <span class="o">=</span> <span class="n">total_nodes</span>
+            <span class="n">leaf2</span> <span class="o">=</span> <span class="n">total_nodes</span> <span class="o">-</span> <span class="mi">1</span>
+            <span class="n">leaves</span> <span class="o">=</span> <span class="p">[</span><span class="n">leaf1</span><span class="p">,</span> <span class="n">leaf2</span><span class="p">]</span>
+            <span class="n">source</span> <span class="o">=</span> <span class="n">leaves</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">leaves</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">))</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="c"># options must not be already sources or targets</span>
+            <span class="n">options</span> <span class="o">=</span> <span class="p">[</span> <span class="n">k</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span><span class="n">v</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">degree</span><span class="p">()</span><span class="o">.</span><span class="n">iteritems</span><span class="p">()</span> \
+                    <span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;is_leaf&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">v</span> <span class="o">==</span> <span class="mi">1</span><span class="p">)</span>  \
+                        <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;source&quot;</span><span class="p">)</span> \
+                        <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;target&quot;</span><span class="p">)]</span>
+            <span class="n">source</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">options</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">))</span>
+        
+        <span class="bp">self</span><span class="o">.</span><span class="n">set_source</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>
+</pre></div></div></div>
+
+          </div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
+          <li><a href="../../index.html" >Module code</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+    </div>
+  </body>
+</html>
\ No newline at end of file