Merge commit '655eefc07db57c1d21cbf11487876c7d8ad6dc11'
[nepi.git] / doc / sphinx / _build / html / _layout / nepi.util.html
diff --git a/doc/sphinx/_build/html/_layout/nepi.util.html b/doc/sphinx/_build/html/_layout/nepi.util.html
new file mode 100644 (file)
index 0000000..cd8a8bc
--- /dev/null
@@ -0,0 +1,1227 @@
+<!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 package &mdash; NEPI 3.2 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.2',
+        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.2 documentation" 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.2 documentation</a> &raquo;</li> 
+      </ul>
+    </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">nepi.util package</a><ul>
+<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#nepi-util-environ-module">nepi.util.environ module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.execfuncs">nepi.util.execfuncs module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.guid">nepi.util.guid module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.logger">nepi.util.logger module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.manifoldapi">nepi.util.manifoldapi module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.netgraph">nepi.util.netgraph module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.parallel">nepi.util.parallel module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.plotter">nepi.util.plotter module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.rmatcher">nepi.util.rmatcher module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.serializer">nepi.util.serializer module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.sfaapi">nepi.util.sfaapi module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.sfarspec_proc">nepi.util.sfarspec_proc module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.sshfuncs">nepi.util.sshfuncs module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.statfuncs">nepi.util.statfuncs module</a></li>
+<li><a class="reference internal" href="#module-nepi.util.timefuncs">nepi.util.timefuncs module</a></li>
+<li><a class="reference internal" href="#module-nepi.util">Module contents</a></li>
+</ul>
+</li>
+</ul>
+
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../_sources/_layout/nepi.util.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<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">
+            
+  <div class="section" id="nepi-util-package">
+<h1>nepi.util package<a class="headerlink" href="#nepi-util-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="nepi.util.parsers.html">nepi.util.parsers package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="nepi.util.parsers.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="nepi.util.parsers.html#module-nepi.util.parsers.xml_parser">nepi.util.parsers.xml_parser module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="nepi.util.parsers.html#module-nepi.util.parsers">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="nepi-util-environ-module">
+<h2>nepi.util.environ module<a class="headerlink" href="#nepi-util-environ-module" title="Permalink to this headline">¶</a></h2>
+<span class="target" id="module-nepi.util.environ"></span><dl class="function">
+<dt id="nepi.util.environ.execute">
+<tt class="descclassname">nepi.util.environ.</tt><tt class="descname">execute</tt><big>(</big><em>cmd</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/environ.html#execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.environ.execute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.environ.backticks">
+<tt class="descclassname">nepi.util.environ.</tt><tt class="descname">backticks</tt><big>(</big><em>cmd</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/environ.html#backticks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.environ.backticks" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.execfuncs">
+<span id="nepi-util-execfuncs-module"></span><h2>nepi.util.execfuncs module<a class="headerlink" href="#module-nepi.util.execfuncs" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="nepi.util.execfuncs.lcopy">
+<tt class="descclassname">nepi.util.execfuncs.</tt><tt class="descname">lcopy</tt><big>(</big><em>source</em>, <em>dest</em>, <em>recursive=False</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/execfuncs.html#lcopy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.execfuncs.lcopy" title="Permalink to this definition">¶</a></dt>
+<dd><p>Copies from/to localy.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.execfuncs.lexec">
+<tt class="descclassname">nepi.util.execfuncs.</tt><tt class="descname">lexec</tt><big>(</big><em>command</em>, <em>user=None</em>, <em>sudo=False</em>, <em>env=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/execfuncs.html#lexec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.execfuncs.lexec" title="Permalink to this definition">¶</a></dt>
+<dd><p>Executes a local command, returns ((stdout,stderr),process)</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.execfuncs.lgetpid">
+<tt class="descclassname">nepi.util.execfuncs.</tt><tt class="descname">lgetpid</tt><big>(</big><em>pidfile</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/execfuncs.html#lgetpid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.execfuncs.lgetpid" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check the pidfile of a process spawned with remote_spawn.</p>
+<dl class="docutils">
+<dt>Parameters:</dt>
+<dd>pidfile: the pidfile passed to remote_span</dd>
+</dl>
+<p>Returns:</p>
+<blockquote>
+<div>A (pid, ppid) tuple useful for calling remote_status and remote_kill,
+or None if the pidfile isn&#8217;t valid yet (maybe the process is still starting).</div></blockquote>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.execfuncs.lkill">
+<tt class="descclassname">nepi.util.execfuncs.</tt><tt class="descname">lkill</tt><big>(</big><em>pid</em>, <em>ppid</em>, <em>sudo=False</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/execfuncs.html#lkill"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.execfuncs.lkill" title="Permalink to this definition">¶</a></dt>
+<dd><p>Kill a process spawned with lspawn.</p>
+<p>First tries a SIGTERM, and if the process does not end in 10 seconds,
+it sends a SIGKILL.</p>
+<dl class="docutils">
+<dt>Parameters:</dt>
+<dd><p class="first">pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid</p>
+<p class="last">sudo: whether the command was run with sudo - careful killing like this.</p>
+</dd>
+</dl>
+<p>Returns:</p>
+<blockquote>
+<div>Nothing, should have killed the process</div></blockquote>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.execfuncs.lspawn">
+<tt class="descclassname">nepi.util.execfuncs.</tt><tt class="descname">lspawn</tt><big>(</big><em>command</em>, <em>pidfile</em>, <em>stdout='/dev/null'</em>, <em>stderr=&lt;class nepi.util.sshfuncs.STDOUT at 0x7f3058d754c8&gt;</em>, <em>stdin='/dev/null'</em>, <em>home=None</em>, <em>create_home=False</em>, <em>sudo=False</em>, <em>user=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/execfuncs.html#lspawn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.execfuncs.lspawn" title="Permalink to this definition">¶</a></dt>
+<dd><p>Spawn a local command such that it will continue working asynchronously.</p>
+<dl class="docutils">
+<dt>Parameters:</dt>
+<dd><p class="first">command: the command to run - it should be a single line.</p>
+<p>pidfile: path of a (ideally unique to this task) pidfile for tracking the process.</p>
+<dl class="docutils">
+<dt>stdout: path of a file to redirect standard output to - must be a string.</dt>
+<dd>Defaults to /dev/null</dd>
+<dt>stderr: path of a file to redirect standard error to - string or the special STDOUT value</dt>
+<dd>to redirect to the same file stdout was redirected to. Defaults to STDOUT.</dd>
+</dl>
+<p>stdin: path of a file with input to be piped into the command&#8217;s standard input</p>
+<p>home: path of a folder to use as working directory - should exist, unless you specify create_home</p>
+<p>create_home: if True, the home folder will be created first with mkdir -p</p>
+<p class="last">sudo: whether the command needs to be executed as root</p>
+</dd>
+<dt>Returns:</dt>
+<dd><p class="first">(stdout, stderr), process</p>
+<p class="last">Of the spawning process, which only captures errors at spawning time.
+Usually only useful for diagnostics.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.execfuncs.lstatus">
+<tt class="descclassname">nepi.util.execfuncs.</tt><tt class="descname">lstatus</tt><big>(</big><em>pid</em>, <em>ppid</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/execfuncs.html#lstatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.execfuncs.lstatus" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check the status of a process spawned with remote_spawn.</p>
+<dl class="docutils">
+<dt>Parameters:</dt>
+<dd>pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid</dd>
+</dl>
+<p>Returns:</p>
+<blockquote>
+<div>One of NOT_STARTED, RUNNING, FINISHED</div></blockquote>
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.guid">
+<span id="nepi-util-guid-module"></span><h2>nepi.util.guid module<a class="headerlink" href="#module-nepi.util.guid" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="nepi.util.guid.GuidGenerator">
+<em class="property">class </em><tt class="descclassname">nepi.util.guid.</tt><tt class="descname">GuidGenerator</tt><a class="reference internal" href="../_modules/nepi/util/guid.html#GuidGenerator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.guid.GuidGenerator" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
+<dl class="method">
+<dt id="nepi.util.guid.GuidGenerator.next">
+<tt class="descname">next</tt><big>(</big><em>guid=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/guid.html#GuidGenerator.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.guid.GuidGenerator.next" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.logger">
+<span id="nepi-util-logger-module"></span><h2>nepi.util.logger module<a class="headerlink" href="#module-nepi.util.logger" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="nepi.util.logger.Logger">
+<em class="property">class </em><tt class="descclassname">nepi.util.logger.</tt><tt class="descname">Logger</tt><big>(</big><em>logger_component</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/logger.html#Logger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.logger.Logger" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
+<dl class="method">
+<dt id="nepi.util.logger.Logger.debug">
+<tt class="descname">debug</tt><big>(</big><em>msg</em>, <em>out=None</em>, <em>err=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/logger.html#Logger.debug"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.logger.Logger.debug" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.logger.Logger.error">
+<tt class="descname">error</tt><big>(</big><em>msg</em>, <em>out=None</em>, <em>err=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/logger.html#Logger.error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.logger.Logger.error" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.logger.Logger.info">
+<tt class="descname">info</tt><big>(</big><em>msg</em>, <em>out=None</em>, <em>err=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/logger.html#Logger.info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.logger.Logger.info" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.logger.Logger.log">
+<tt class="descname">log</tt><big>(</big><em>msg</em>, <em>level</em>, <em>out=None</em>, <em>err=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/logger.html#Logger.log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.logger.Logger.log" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.logger.Logger.log_message">
+<tt class="descname">log_message</tt><big>(</big><em>msg</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/logger.html#Logger.log_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.logger.Logger.log_message" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.logger.Logger.logger">
+<tt class="descname">logger</tt><a class="reference internal" href="../_modules/nepi/util/logger.html#Logger.logger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.logger.Logger.logger" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.logger.Logger.warning">
+<tt class="descname">warning</tt><big>(</big><em>msg</em>, <em>out=None</em>, <em>err=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/logger.html#Logger.warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.logger.Logger.warning" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.manifoldapi">
+<span id="nepi-util-manifoldapi-module"></span><h2>nepi.util.manifoldapi module<a class="headerlink" href="#module-nepi.util.manifoldapi" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="nepi.util.manifoldapi.MANIFOLDAPI">
+<em class="property">class </em><tt class="descclassname">nepi.util.manifoldapi.</tt><tt class="descname">MANIFOLDAPI</tt><big>(</big><em>username</em>, <em>password</em>, <em>hostname</em>, <em>urlpattern</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/manifoldapi.html#MANIFOLDAPI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.manifoldapi.MANIFOLDAPI" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
+<p>API to query different data platforms as SFA, TopHat, OML Central Server,
+using Manifold Framework, the backend of MySlice.</p>
+<dl class="method">
+<dt id="nepi.util.manifoldapi.MANIFOLDAPI.add_resource_to_slice">
+<tt class="descname">add_resource_to_slice</tt><big>(</big><em>slicename</em>, <em>resource_urn</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/manifoldapi.html#MANIFOLDAPI.add_resource_to_slice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.manifoldapi.MANIFOLDAPI.add_resource_to_slice" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add resource to user&#8217;s slice. The query needs to specify the new
+resource plus the previous resources already in the slice.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.manifoldapi.MANIFOLDAPI.api">
+<tt class="descname">api</tt><a class="reference internal" href="../_modules/nepi/util/manifoldapi.html#MANIFOLDAPI.api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.manifoldapi.MANIFOLDAPI.api" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.manifoldapi.MANIFOLDAPI.get_resource_info">
+<tt class="descname">get_resource_info</tt><big>(</big><em>filters=None</em>, <em>fields=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/manifoldapi.html#MANIFOLDAPI.get_resource_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.manifoldapi.MANIFOLDAPI.get_resource_info" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create and execute the Manifold API Query to get the resources 
+according fields and filters.
+:param filters: resource&#8217;s constraints for the experiment
+:type filters: dict
+:param fields: desire fields in the result of the query
+:type fields: list</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.manifoldapi.MANIFOLDAPI.get_resource_urn">
+<tt class="descname">get_resource_urn</tt><big>(</big><em>filters=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/manifoldapi.html#MANIFOLDAPI.get_resource_urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.manifoldapi.MANIFOLDAPI.get_resource_urn" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieves the resources urn of the resources matching filters.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.manifoldapi.MANIFOLDAPI.get_session_key">
+<tt class="descname">get_session_key</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/manifoldapi.html#MANIFOLDAPI.get_session_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.manifoldapi.MANIFOLDAPI.get_session_key" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieves the session key, in order to use the same session for 
+queries.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.manifoldapi.MANIFOLDAPI.get_slice_resources">
+<tt class="descname">get_slice_resources</tt><big>(</big><em>slicename</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/manifoldapi.html#MANIFOLDAPI.get_slice_resources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.manifoldapi.MANIFOLDAPI.get_slice_resources" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retrieves resources attached to user&#8217;s slice.
+return value: list of resources&#8217; urn</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.manifoldapi.MANIFOLDAPI.remove_resource_from_slice">
+<tt class="descname">remove_resource_from_slice</tt><big>(</big><em>slicename</em>, <em>resource_urn</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/manifoldapi.html#MANIFOLDAPI.remove_resource_from_slice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.manifoldapi.MANIFOLDAPI.remove_resource_from_slice" title="Permalink to this definition">¶</a></dt>
+<dd><p>Remove resource from user&#8217;s slice. The query needs to specify the list
+of previous resources in the slice without the one to be remove.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="nepi.util.manifoldapi.MANIFOLDAPIFactory">
+<em class="property">class </em><tt class="descclassname">nepi.util.manifoldapi.</tt><tt class="descname">MANIFOLDAPIFactory</tt><a class="reference internal" href="../_modules/nepi/util/manifoldapi.html#MANIFOLDAPIFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.manifoldapi.MANIFOLDAPIFactory" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
+<p>API Factory to manage a map of MANIFOLDAPI instances as key-value pairs, it
+instanciate a single instance per key. The key represents the same SFA, 
+MF (ManiFold) credentials.</p>
+<dl class="classmethod">
+<dt id="nepi.util.manifoldapi.MANIFOLDAPIFactory.get_api">
+<em class="property">classmethod </em><tt class="descname">get_api</tt><big>(</big><em>username</em>, <em>password</em>, <em>hostname='test.myslice.info'</em>, <em>urlpattern='http://%(hostname)s:7080'</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/manifoldapi.html#MANIFOLDAPIFactory.get_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.manifoldapi.MANIFOLDAPIFactory.get_api" title="Permalink to this definition">¶</a></dt>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>username</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Manifold user (also used for MySlice web login)</li>
+<li><strong>password</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Manifold password (also used for MySlice web login)</li>
+<li><strong>hostname</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Hostname of the Manifold API to query SFA, TopHat, etc</li>
+<li><strong>urlpattern</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Url of the Manifold API to query SFA, TopHat, etc</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="classmethod">
+<dt id="nepi.util.manifoldapi.MANIFOLDAPIFactory.make_key">
+<em class="property">classmethod </em><tt class="descname">make_key</tt><big>(</big><em>*args</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/manifoldapi.html#MANIFOLDAPIFactory.make_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.manifoldapi.MANIFOLDAPIFactory.make_key" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.netgraph">
+<span id="nepi-util-netgraph-module"></span><h2>nepi.util.netgraph module<a class="headerlink" href="#module-nepi.util.netgraph" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="nepi.util.netgraph.NetGraph">
+<em class="property">class </em><tt class="descclassname">nepi.util.netgraph.</tt><tt class="descname">NetGraph</tt><big>(</big><em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
+<p>NetGraph represents a network topology. 
+Network graphs are internally using the networkx library.</p>
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.add_edge">
+<tt class="descname">add_edge</tt><big>(</big><em>nid1</em>, <em>nid2</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.add_edge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.add_edge" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.add_node">
+<tt class="descname">add_node</tt><big>(</big><em>nid</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.add_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.add_node" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.annotate_edge">
+<tt class="descname">annotate_edge</tt><big>(</big><em>nid1</em>, <em>nid2</em>, <em>name</em>, <em>value</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.annotate_edge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.annotate_edge" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.annotate_edge_net">
+<tt class="descname">annotate_edge_net</tt><big>(</big><em>nid1</em>, <em>nid2</em>, <em>ip1</em>, <em>ip2</em>, <em>mask</em>, <em>network</em>, <em>prefixlen</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.annotate_edge_net"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.annotate_edge_net" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.annotate_node">
+<tt class="descname">annotate_node</tt><big>(</big><em>nid</em>, <em>name</em>, <em>value</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.annotate_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.annotate_node" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.annotate_node_ip">
+<tt class="descname">annotate_node_ip</tt><big>(</big><em>nid</em>, <em>ip</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.annotate_node_ip"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.annotate_node_ip" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.assign_p2p_ips">
+<tt class="descname">assign_p2p_ips</tt><big>(</big><em>network='10.0.0.0'</em>, <em>prefix=8</em>, <em>version=4</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.assign_p2p_ips"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.assign_p2p_ips" title="Permalink to this definition">¶</a></dt>
+<dd><p>Assign IP addresses to each end of each edge of the network graph,
+computing all the point to point subnets and addresses in the network
+representation.</p>
+<blockquote>
+<div><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">param network:</th><td class="field-body">Base network address used for subnetting.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type network:</th><td class="field-body">str</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param prefix:</th><td class="field-body">Prefix for the base network address used for subnetting.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type prefixt:</th><td class="field-body">int</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param version:</th><td class="field-body">IP version (either 4 or 6).</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type version:</th><td class="field-body">int</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.del_edge_annotation">
+<tt class="descname">del_edge_annotation</tt><big>(</big><em>nid1</em>, <em>nid2</em>, <em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.del_edge_annotation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.del_edge_annotation" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.del_node_annotation">
+<tt class="descname">del_node_annotation</tt><big>(</big><em>nid</em>, <em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.del_node_annotation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.del_node_annotation" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.edge_annotation">
+<tt class="descname">edge_annotation</tt><big>(</big><em>nid1</em>, <em>nid2</em>, <em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.edge_annotation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.edge_annotation" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.edge_annotations">
+<tt class="descname">edge_annotations</tt><big>(</big><em>nid1</em>, <em>nid2</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.edge_annotations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.edge_annotations" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.edge_net_annotation">
+<tt class="descname">edge_net_annotation</tt><big>(</big><em>nid1</em>, <em>nid2</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.edge_net_annotation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.edge_net_annotation" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.edges">
+<tt class="descname">edges</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.edges"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.edges" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.generate_topology">
+<tt class="descname">generate_topology</tt><big>(</big><em>topo_type</em>, <em>node_count</em>, <em>branches=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.generate_topology"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.generate_topology" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.get_p2p_info">
+<tt class="descname">get_p2p_info</tt><big>(</big><em>nid1</em>, <em>nid2</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.get_p2p_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.get_p2p_info" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.is_source">
+<tt class="descname">is_source</tt><big>(</big><em>nid</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.is_source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.is_source" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.is_target">
+<tt class="descname">is_target</tt><big>(</big><em>nid</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.is_target"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.is_target" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.node_annotation">
+<tt class="descname">node_annotation</tt><big>(</big><em>nid</em>, <em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.node_annotation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.node_annotation" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.node_annotations">
+<tt class="descname">node_annotations</tt><big>(</big><em>nid</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.node_annotations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.node_annotations" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.node_ip_annotations">
+<tt class="descname">node_ip_annotations</tt><big>(</big><em>nid</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.node_ip_annotations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.node_ip_annotations" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.nodes">
+<tt class="descname">nodes</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.nodes" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.netgraph.NetGraph.order">
+<tt class="descname">order</tt><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.order"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.order" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.select_random_source">
+<tt class="descname">select_random_source</tt><big>(</big><em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.select_random_source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.select_random_source" title="Permalink to this definition">¶</a></dt>
+<dd><p>Mark a random node as source.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.select_target_zero">
+<tt class="descname">select_target_zero</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.select_target_zero"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.select_target_zero" title="Permalink to this definition">¶</a></dt>
+<dd><p>Mark the node 0 as target</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.set_source">
+<tt class="descname">set_source</tt><big>(</big><em>nid</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.set_source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.set_source" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.set_target">
+<tt class="descname">set_target</tt><big>(</big><em>nid</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.set_target"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.set_target" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.sources">
+<tt class="descname">sources</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.sources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.sources" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the nodes that are sources</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.netgraph.NetGraph.targets">
+<tt class="descname">targets</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.targets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.targets" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the nodes that are targets</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.netgraph.NetGraph.topo_type">
+<tt class="descname">topo_type</tt><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.topo_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.topo_type" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.netgraph.NetGraph.topology">
+<tt class="descname">topology</tt><a class="reference internal" href="../_modules/nepi/util/netgraph.html#NetGraph.topology"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.NetGraph.topology" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="nepi.util.netgraph.TopologyType">
+<em class="property">class </em><tt class="descclassname">nepi.util.netgraph.</tt><tt class="descname">TopologyType</tt><a class="reference internal" href="../_modules/nepi/util/netgraph.html#TopologyType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.netgraph.TopologyType" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="attribute">
+<dt id="nepi.util.netgraph.TopologyType.ADHOC">
+<tt class="descname">ADHOC</tt><em class="property"> = 'adhoc'</em><a class="headerlink" href="#nepi.util.netgraph.TopologyType.ADHOC" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.netgraph.TopologyType.LADDER">
+<tt class="descname">LADDER</tt><em class="property"> = 'ladder'</em><a class="headerlink" href="#nepi.util.netgraph.TopologyType.LADDER" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.netgraph.TopologyType.LINEAR">
+<tt class="descname">LINEAR</tt><em class="property"> = 'linear'</em><a class="headerlink" href="#nepi.util.netgraph.TopologyType.LINEAR" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.netgraph.TopologyType.MESH">
+<tt class="descname">MESH</tt><em class="property"> = 'mesh'</em><a class="headerlink" href="#nepi.util.netgraph.TopologyType.MESH" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.netgraph.TopologyType.STAR">
+<tt class="descname">STAR</tt><em class="property"> = 'star'</em><a class="headerlink" href="#nepi.util.netgraph.TopologyType.STAR" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.netgraph.TopologyType.TREE">
+<tt class="descname">TREE</tt><em class="property"> = 'tree'</em><a class="headerlink" href="#nepi.util.netgraph.TopologyType.TREE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.parallel">
+<span id="nepi-util-parallel-module"></span><h2>nepi.util.parallel module<a class="headerlink" href="#module-nepi.util.parallel" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="nepi.util.parallel.ParallelRun">
+<em class="property">class </em><tt class="descclassname">nepi.util.parallel.</tt><tt class="descname">ParallelRun</tt><big>(</big><em>maxthreads=None</em>, <em>maxqueue=None</em>, <em>results=True</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#ParallelRun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.ParallelRun" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
+<dl class="method">
+<dt id="nepi.util.parallel.ParallelRun.destroy">
+<tt class="descname">destroy</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#ParallelRun.destroy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.ParallelRun.destroy" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.parallel.ParallelRun.empty">
+<tt class="descname">empty</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#ParallelRun.empty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.ParallelRun.empty" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.parallel.ParallelRun.initialize_workers">
+<tt class="descname">initialize_workers</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#ParallelRun.initialize_workers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.ParallelRun.initialize_workers" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.parallel.ParallelRun.join">
+<tt class="descname">join</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#ParallelRun.join"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.ParallelRun.join" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.parallel.ParallelRun.put">
+<tt class="descname">put</tt><big>(</big><em>callable</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#ParallelRun.put"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.ParallelRun.put" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.parallel.ParallelRun.put_nowait">
+<tt class="descname">put_nowait</tt><big>(</big><em>callable</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#ParallelRun.put_nowait"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.ParallelRun.put_nowait" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.parallel.ParallelRun.start">
+<tt class="descname">start</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#ParallelRun.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.ParallelRun.start" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.parallel.ParallelRun.sync">
+<tt class="descname">sync</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#ParallelRun.sync"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.ParallelRun.sync" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="nepi.util.parallel.WorkerThread">
+<em class="property">class </em><tt class="descclassname">nepi.util.parallel.</tt><tt class="descname">WorkerThread</tt><big>(</big><em>group=None</em>, <em>target=None</em>, <em>name=None</em>, <em>args=()</em>, <em>kwargs=None</em>, <em>verbose=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#WorkerThread"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.WorkerThread" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/threading.html#threading.Thread" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">threading.Thread</span></tt></a></p>
+<dl class="class">
+<dt id="nepi.util.parallel.WorkerThread.QUIT">
+<em class="property">class </em><tt class="descname">QUIT</tt><a class="reference internal" href="../_modules/nepi/util/parallel.html#WorkerThread.QUIT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.WorkerThread.QUIT" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.parallel.WorkerThread.attach">
+<tt class="descclassname">WorkerThread.</tt><tt class="descname">attach</tt><big>(</big><em>queue</em>, <em>rvqueue</em>, <em>delayed_exceptions</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#WorkerThread.attach"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.WorkerThread.attach" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.parallel.WorkerThread.quit">
+<tt class="descclassname">WorkerThread.</tt><tt class="descname">quit</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#WorkerThread.quit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.WorkerThread.quit" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.parallel.WorkerThread.run">
+<tt class="descclassname">WorkerThread.</tt><tt class="descname">run</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/parallel.html#WorkerThread.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.parallel.WorkerThread.run" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.plotter">
+<span id="nepi-util-plotter-module"></span><h2>nepi.util.plotter module<a class="headerlink" href="#module-nepi.util.plotter" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="nepi.util.plotter.ECPlotter">
+<em class="property">class </em><tt class="descclassname">nepi.util.plotter.</tt><tt class="descname">ECPlotter</tt><a class="reference internal" href="../_modules/nepi/util/plotter.html#ECPlotter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.plotter.ECPlotter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
+<dl class="method">
+<dt id="nepi.util.plotter.ECPlotter.plot">
+<tt class="descname">plot</tt><big>(</big><em>ec</em>, <em>dirpath=None</em>, <em>format='figure'</em>, <em>show=False</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/plotter.html#ECPlotter.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.plotter.ECPlotter.plot" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="nepi.util.plotter.PFormats">
+<em class="property">class </em><tt class="descclassname">nepi.util.plotter.</tt><tt class="descname">PFormats</tt><a class="reference internal" href="../_modules/nepi/util/plotter.html#PFormats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.plotter.PFormats" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="attribute">
+<dt id="nepi.util.plotter.PFormats.DOT">
+<tt class="descname">DOT</tt><em class="property"> = 'dot'</em><a class="headerlink" href="#nepi.util.plotter.PFormats.DOT" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.plotter.PFormats.FIGURE">
+<tt class="descname">FIGURE</tt><em class="property"> = 'figure'</em><a class="headerlink" href="#nepi.util.plotter.PFormats.FIGURE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.rmatcher">
+<span id="nepi-util-rmatcher-module"></span><h2>nepi.util.rmatcher module<a class="headerlink" href="#module-nepi.util.rmatcher" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="nepi.util.rmatcher.find_boxes">
+<tt class="descclassname">nepi.util.rmatcher.</tt><tt class="descname">find_boxes</tt><big>(</big><em>box</em>, <em>all_tags=None</em>, <em>exact_tags=None</em>, <em>max_depth=1</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/rmatcher.html#find_boxes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.rmatcher.find_boxes" title="Permalink to this definition">¶</a></dt>
+<dd><p>Look for the connected boxes with the required tags, doing breath-first
+search, until max_depth ( max_depth = None will traverse the entire graph ).</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.rmatcher.match_tags">
+<tt class="descclassname">nepi.util.rmatcher.</tt><tt class="descname">match_tags</tt><big>(</big><em>box</em>, <em>all_tags</em>, <em>exact_tags</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/rmatcher.html#match_tags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.rmatcher.match_tags" title="Permalink to this definition">¶</a></dt>
+<dd><p>returns True if box has required tags</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.serializer">
+<span id="nepi-util-serializer-module"></span><h2>nepi.util.serializer module<a class="headerlink" href="#module-nepi.util.serializer" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="nepi.util.serializer.ECSerializer">
+<em class="property">class </em><tt class="descclassname">nepi.util.serializer.</tt><tt class="descname">ECSerializer</tt><a class="reference internal" href="../_modules/nepi/util/serializer.html#ECSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.serializer.ECSerializer" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
+<dl class="method">
+<dt id="nepi.util.serializer.ECSerializer.load">
+<tt class="descname">load</tt><big>(</big><em>filepath</em>, <em>format='xml'</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/serializer.html#ECSerializer.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.serializer.ECSerializer.load" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.serializer.ECSerializer.save">
+<tt class="descname">save</tt><big>(</big><em>ec</em>, <em>dirpath</em>, <em>format='xml'</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/serializer.html#ECSerializer.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.serializer.ECSerializer.save" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.serializer.ECSerializer.serialize">
+<tt class="descname">serialize</tt><big>(</big><em>ec</em>, <em>format='xml'</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/serializer.html#ECSerializer.serialize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.serializer.ECSerializer.serialize" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="nepi.util.serializer.SFormats">
+<em class="property">class </em><tt class="descclassname">nepi.util.serializer.</tt><tt class="descname">SFormats</tt><a class="reference internal" href="../_modules/nepi/util/serializer.html#SFormats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.serializer.SFormats" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="attribute">
+<dt id="nepi.util.serializer.SFormats.XML">
+<tt class="descname">XML</tt><em class="property"> = 'xml'</em><a class="headerlink" href="#nepi.util.serializer.SFormats.XML" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.sfaapi">
+<span id="nepi-util-sfaapi-module"></span><h2>nepi.util.sfaapi module<a class="headerlink" href="#module-nepi.util.sfaapi" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="nepi.util.sfaapi.SFAAPI">
+<em class="property">class </em><tt class="descclassname">nepi.util.sfaapi.</tt><tt class="descname">SFAAPI</tt><big>(</big><em>sfi_user</em>, <em>sfi_auth</em>, <em>sfi_registry</em>, <em>sfi_sm</em>, <em>private_key</em>, <em>ec</em>, <em>batch</em>, <em>rtype</em>, <em>timeout</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
+<p>API for quering the SFA service. It uses Sfi class from the tool sfi client.</p>
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.add_resource_to_slice">
+<tt class="descname">add_resource_to_slice</tt><big>(</big><em>slicename</em>, <em>resource_hrn</em>, <em>leases=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.add_resource_to_slice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.add_resource_to_slice" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get the list of resources&#8217; urn, build the rspec string and call the allocate 
+and provision method.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.add_resource_to_slice_batch">
+<tt class="descname">add_resource_to_slice_batch</tt><big>(</big><em>slicename</em>, <em>resource_hrn</em>, <em>properties=None</em>, <em>leases=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.add_resource_to_slice_batch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.add_resource_to_slice_batch" title="Permalink to this definition">¶</a></dt>
+<dd><p>Method to add all resources together to the slice. Previous deletion of slivers.
+Specially used for wilabt that doesn&#8217;t allow to add more resources to the slice
+after some resources are added. Every sliver have to be deleted and the batch 
+has to be added at once.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.blacklist_resource">
+<tt class="descname">blacklist_resource</tt><big>(</big><em>resource_hrn</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.blacklist_resource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.blacklist_resource" title="Permalink to this definition">¶</a></dt>
+<dd><p>Adding resource_hrn to blacklist, and taking 
+the resource from the reserved list.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.blacklisted">
+<tt class="descname">blacklisted</tt><big>(</big><em>resource_hrn</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.blacklisted"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.blacklisted" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check if the resource is in the blacklist.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.get_resources_hrn">
+<tt class="descname">get_resources_hrn</tt><big>(</big><em>resources=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.get_resources_hrn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.get_resources_hrn" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get list of resources hrn, without the resource info.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.get_resources_info">
+<tt class="descname">get_resources_info</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.get_resources_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.get_resources_info" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get all resources and its attributes from aggregate.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.get_slice_resources">
+<tt class="descname">get_slice_resources</tt><big>(</big><em>slicename</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.get_slice_resources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.get_slice_resources" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get resources and info from slice.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.release">
+<tt class="descname">release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.release" title="Permalink to this definition">¶</a></dt>
+<dd><p>Remove hosts from the reserved and blacklist lists, and in case
+the persist attribute is set, it saves the blacklisted hosts
+in the blacklist file.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.remove_all_from_slice">
+<tt class="descname">remove_all_from_slice</tt><big>(</big><em>slicename</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.remove_all_from_slice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.remove_all_from_slice" title="Permalink to this definition">¶</a></dt>
+<dd><p>De-allocate and de-provision all slivers of the named slice.
+Currently sfi doesn&#8217;t support removing particular
+slivers, so this method works only for removing every sliver. Setting the
+resource_hrn parameter is not necessary.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.remove_resource_from_slice">
+<tt class="descname">remove_resource_from_slice</tt><big>(</big><em>slicename</em>, <em>resource_hrn</em>, <em>leases=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.remove_resource_from_slice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.remove_resource_from_slice" title="Permalink to this definition">¶</a></dt>
+<dd><p>Remove slivers from slice. Currently sfi doesn&#8217;t support removing particular
+slivers.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.reserve_resource">
+<tt class="descname">reserve_resource</tt><big>(</big><em>resource_hrn</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.reserve_resource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.reserve_resource" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add resource to the reserved list.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfaapi.SFAAPI.reserved">
+<tt class="descname">reserved</tt><big>(</big><em>resource_hrn</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPI.reserved"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPI.reserved" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check that the resource in not reserved.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="nepi.util.sfaapi.SFAAPIFactory">
+<em class="property">class </em><tt class="descclassname">nepi.util.sfaapi.</tt><tt class="descname">SFAAPIFactory</tt><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPIFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPIFactory" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
+<p>API Factory to manage a map of SFAAPI instances as key-value pairs, it
+instanciate a single instance per key. The key represents the same SFA, 
+credentials.</p>
+<dl class="classmethod">
+<dt id="nepi.util.sfaapi.SFAAPIFactory.get_api">
+<em class="property">classmethod </em><tt class="descname">get_api</tt><big>(</big><em>sfi_user</em>, <em>sfi_auth</em>, <em>sfi_registry</em>, <em>sfi_sm</em>, <em>private_key</em>, <em>ec</em>, <em>batch=False</em>, <em>rtype=None</em>, <em>timeout=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPIFactory.get_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPIFactory.get_api" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="classmethod">
+<dt id="nepi.util.sfaapi.SFAAPIFactory.make_key">
+<em class="property">classmethod </em><tt class="descname">make_key</tt><big>(</big><em>*args</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfaapi.html#SFAAPIFactory.make_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfaapi.SFAAPIFactory.make_key" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.sfarspec_proc">
+<span id="nepi-util-sfarspec-proc-module"></span><h2>nepi.util.sfarspec_proc module<a class="headerlink" href="#module-nepi.util.sfarspec_proc" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="nepi.util.sfarspec_proc.SfaRSpecProcessing">
+<em class="property">class </em><tt class="descclassname">nepi.util.sfarspec_proc.</tt><tt class="descname">SfaRSpecProcessing</tt><big>(</big><em>config=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfarspec_proc.html#SfaRSpecProcessing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfarspec_proc.SfaRSpecProcessing" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
+<p>Class to process SFA RSpecs, parse the RSpec replies such as Advertisement RSpecs,
+and build in the case of Request RSpecs.</p>
+<dl class="method">
+<dt id="nepi.util.sfarspec_proc.SfaRSpecProcessing.build_sfa_rspec">
+<tt class="descname">build_sfa_rspec</tt><big>(</big><em>slice_id</em>, <em>resources</em>, <em>properties</em>, <em>leases</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfarspec_proc.html#SfaRSpecProcessing.build_sfa_rspec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfarspec_proc.SfaRSpecProcessing.build_sfa_rspec" title="Permalink to this definition">¶</a></dt>
+<dd><p>Build the XML RSpec from list of resources&#8217; urns.
+eg. resources = [&#8220;<a class="reference external" href="urn:publicid:IDN+ple:modenaple+node+planetlab-1.ing.unimo.it">urn:publicid:IDN+ple:modenaple+node+planetlab-1.ing.unimo.it</a>&#8220;]</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfarspec_proc.SfaRSpecProcessing.make_dict_rec">
+<tt class="descname">make_dict_rec</tt><big>(</big><em>obj</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfarspec_proc.html#SfaRSpecProcessing.make_dict_rec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfarspec_proc.SfaRSpecProcessing.make_dict_rec" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.util.sfarspec_proc.SfaRSpecProcessing.parse_sfa_rspec">
+<tt class="descname">parse_sfa_rspec</tt><big>(</big><em>rspec_string</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sfarspec_proc.html#SfaRSpecProcessing.parse_sfa_rspec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sfarspec_proc.SfaRSpecProcessing.parse_sfa_rspec" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parse the RSpec XML as a string.</p>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.sshfuncs">
+<span id="nepi-util-sshfuncs-module"></span><h2>nepi.util.sshfuncs module<a class="headerlink" href="#module-nepi.util.sshfuncs" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="nepi.util.sshfuncs.ProcStatus">
+<em class="property">class </em><tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">ProcStatus</tt><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#ProcStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.ProcStatus" title="Permalink to this definition">¶</a></dt>
+<dd><p>Codes for status of remote spawned process</p>
+<dl class="attribute">
+<dt id="nepi.util.sshfuncs.ProcStatus.FINISHED">
+<tt class="descname">FINISHED</tt><em class="property"> = 2</em><a class="headerlink" href="#nepi.util.sshfuncs.ProcStatus.FINISHED" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.sshfuncs.ProcStatus.NOT_STARTED">
+<tt class="descname">NOT_STARTED</tt><em class="property"> = 3</em><a class="headerlink" href="#nepi.util.sshfuncs.ProcStatus.NOT_STARTED" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.util.sshfuncs.ProcStatus.RUNNING">
+<tt class="descname">RUNNING</tt><em class="property"> = 1</em><a class="headerlink" href="#nepi.util.sshfuncs.ProcStatus.RUNNING" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="nepi.util.sshfuncs.STDOUT">
+<em class="property">class </em><tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">STDOUT</tt><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#STDOUT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.STDOUT" title="Permalink to this definition">¶</a></dt>
+<dd><p>Special value that when given to rspawn in stderr causes stderr to 
+redirect to whatever stdout was redirected to.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.eintr_retry">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">eintr_retry</tt><big>(</big><em>func</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#eintr_retry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.eintr_retry" title="Permalink to this definition">¶</a></dt>
+<dd><p>Retries a function invocation when a EINTR occurs</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.gethostbyname">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">gethostbyname</tt><big>(</big><em>host</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#gethostbyname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.gethostbyname" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.log">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">log</tt><big>(</big><em>msg</em>, <em>level</em>, <em>out=None</em>, <em>err=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.log" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.make_control_path">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">make_control_path</tt><big>(</big><em>agent</em>, <em>forward_x11</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#make_control_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.make_control_path" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.make_server_key_args">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">make_server_key_args</tt><big>(</big><em>server_key</em>, <em>host</em>, <em>port</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#make_server_key_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.make_server_key_args" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns a reference to a temporary known_hosts file, to which 
+the server key has been added.</p>
+<p>Make sure to hold onto the temp file reference until the process is 
+done with it</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>server_key</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the server public key</li>
+<li><strong>host</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the hostname</li>
+<li><strong>port</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the ssh port</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.openssh_has_persist">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">openssh_has_persist</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#openssh_has_persist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.openssh_has_persist" title="Permalink to this definition">¶</a></dt>
+<dd><p>The ssh_config options ControlMaster and ControlPersist allow to
+reuse a same network connection for multiple ssh sessions. In this 
+way limitations on number of open ssh connections can be bypassed.
+However, older versions of openSSH do not support this feature.
+This function is used to determine if ssh connection persist features
+can be used.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.rcopy">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">rcopy</tt><big>(</big><em>source</em>, <em>dest</em>, <em>port=None</em>, <em>gwuser=None</em>, <em>gw=None</em>, <em>recursive=False</em>, <em>identity=None</em>, <em>server_key=None</em>, <em>retry=3</em>, <em>strict_host_checking=True</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#rcopy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.rcopy" title="Permalink to this definition">¶</a></dt>
+<dd><p>Copies from/to remote sites.</p>
+<p>Source and destination should have the user and host encoded
+as per scp specs.</p>
+<p>Source can be a list of files to copy to a single destination, 
+(in which case it is advised that the destination be a folder),
+or a single file in a string.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.resolve_hostname">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">resolve_hostname</tt><big>(</big><em>host</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#resolve_hostname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.resolve_hostname" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.rexec">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">rexec</tt><big>(</big><em>command</em>, <em>host</em>, <em>user</em>, <em>port=None</em>, <em>gwuser=None</em>, <em>gw=None</em>, <em>agent=True</em>, <em>sudo=False</em>, <em>identity=None</em>, <em>server_key=None</em>, <em>env=None</em>, <em>tty=False</em>, <em>connect_timeout=30</em>, <em>retry=3</em>, <em>persistent=True</em>, <em>forward_x11=False</em>, <em>blocking=True</em>, <em>strict_host_checking=True</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#rexec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.rexec" title="Permalink to this definition">¶</a></dt>
+<dd><p>Executes a remote command, returns ((stdout,stderr),process)</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.rgetpid">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">rgetpid</tt><big>(</big><em>*p</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#rgetpid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.rgetpid" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the pid and ppid of a process from a remote file where the 
+information was stored.</p>
+<blockquote>
+<div><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">param home:</th><td class="field-body">Path to directory where the pidfile is located</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type home:</th><td class="field-body">str</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param pidfile:</th><td class="field-body">Name of file containing the pid information</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type pidfile:</th><td class="field-body">str</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">rtype:</th><td class="field-body">int</td>
+</tr>
+</tbody>
+</table>
+<p>A (pid, ppid) tuple useful for calling rstatus and rkill,
+or None if the pidfile isn&#8217;t valid yet (can happen when process is staring up)</p>
+</div></blockquote>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.rkill">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">rkill</tt><big>(</big><em>*p</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#rkill"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.rkill" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sends a kill signal to a remote process.</p>
+<p>First tries a SIGTERM, and if the process does not end in 10 seconds,
+it sends a SIGKILL.</p>
+<blockquote>
+<div><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">param pid:</th><td class="field-body">Process id of process to be killed</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type pid:</th><td class="field-body">int</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param ppid:</th><td class="field-body">Parent process id of process to be killed</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type ppid:</th><td class="field-body">int</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param sudo:</th><td class="field-body">Flag indicating if sudo should be used to kill the process</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type sudo:</th><td class="field-body">bool</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.rspawn">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">rspawn</tt><big>(</big><em>command</em>, <em>pidfile</em>, <em>stdout='/dev/null'</em>, <em>stderr=&lt;class nepi.util.sshfuncs.STDOUT at 0x7f3058d754c8&gt;</em>, <em>stdin='/dev/null'</em>, <em>home=None</em>, <em>create_home=False</em>, <em>sudo=False</em>, <em>host=None</em>, <em>port=None</em>, <em>user=None</em>, <em>gwuser=None</em>, <em>gw=None</em>, <em>agent=None</em>, <em>identity=None</em>, <em>server_key=None</em>, <em>tty=False</em>, <em>strict_host_checking=True</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#rspawn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.rspawn" title="Permalink to this definition">¶</a></dt>
+<dd><p>Spawn a remote command such that it will continue working asynchronously in 
+background.</p>
+<blockquote>
+<div><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">param command:</th><td class="field-body">The command to run, it should be a single line.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type command:</th><td class="field-body">str</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param pidfile:</th><td class="field-body">Path to a file where to store the pid and ppid of the 
+spawned process</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type pidfile:</th><td class="field-body">str</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param stdout:</th><td class="field-body">Path to file to redirect standard output. 
+The default value is /dev/null</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type stdout:</th><td class="field-body">str</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param stderr:</th><td class="field-body">Path to file to redirect standard error.
+If the special STDOUT value is used, stderr will 
+be redirected to the same file as stdout</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type stderr:</th><td class="field-body">str</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param stdin:</th><td class="field-body">Path to a file with input to be piped into the command&#8217;s standard input</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type stdin:</th><td class="field-body">str</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param home:</th><td class="field-body">Path to working directory folder. 
+It is assumed to exist unless the create_home flag is set.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type home:</th><td class="field-body">str</td>
+</tr>
+<tr class="field-odd field"><th class="field-name" colspan="2">param create_home:</th></tr>
+<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">Flag to force creation of the home folder before 
+running the command</td>
+</tr>
+<tr class="field-even field"><th class="field-name" colspan="2">type create_home:</th></tr>
+<tr class="field-even field"><td>&nbsp;</td><td class="field-body">bool</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param sudo:</th><td class="field-body">Flag forcing execution with sudo user</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type sudo:</th><td class="field-body">bool</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">rtype:</th><td class="field-body">tuple</td>
+</tr>
+</tbody>
+</table>
+<p>(stdout, stderr), process</p>
+<p>Of the spawning process, which only captures errors at spawning time.
+Usually only useful for diagnostics.</p>
+</div></blockquote>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.rstatus">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">rstatus</tt><big>(</big><em>*p</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#rstatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.rstatus" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns a code representing the the status of a remote process</p>
+<blockquote>
+<div><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">param pid:</th><td class="field-body">Process id of the process</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type pid:</th><td class="field-body">int</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">param ppid:</th><td class="field-body">Parent process id of process</td>
+</tr>
+<tr class="field-even field"><th class="field-name">type ppid:</th><td class="field-body">int</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">rtype:</th><td class="field-body">int (One of NOT_STARTED, RUNNING, FINISHED)</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.sshfuncs.shell_escape">
+<tt class="descclassname">nepi.util.sshfuncs.</tt><tt class="descname">shell_escape</tt><big>(</big><em>s</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/sshfuncs.html#shell_escape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.sshfuncs.shell_escape" title="Permalink to this definition">¶</a></dt>
+<dd><p>Escapes strings so that they are safe to use as command-line 
+arguments</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.statfuncs">
+<span id="nepi-util-statfuncs-module"></span><h2>nepi.util.statfuncs module<a class="headerlink" href="#module-nepi.util.statfuncs" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="nepi.util.statfuncs.compute_mean">
+<tt class="descclassname">nepi.util.statfuncs.</tt><tt class="descname">compute_mean</tt><big>(</big><em>sample</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/statfuncs.html#compute_mean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.statfuncs.compute_mean" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util.timefuncs">
+<span id="nepi-util-timefuncs-module"></span><h2>nepi.util.timefuncs module<a class="headerlink" href="#module-nepi.util.timefuncs" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="nepi.util.timefuncs.compute_delay_ms">
+<tt class="descclassname">nepi.util.timefuncs.</tt><tt class="descname">compute_delay_ms</tt><big>(</big><em>timestamp2</em>, <em>timestamp1</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/timefuncs.html#compute_delay_ms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.timefuncs.compute_delay_ms" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.timefuncs.stabsformat">
+<tt class="descclassname">nepi.util.timefuncs.</tt><tt class="descname">stabsformat</tt><big>(</big><em>sdate</em>, <em>dbase=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/timefuncs.html#stabsformat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.timefuncs.stabsformat" title="Permalink to this definition">¶</a></dt>
+<dd><p>Constructs a datetime object from a string date.
+The string date can be expressed as an absolute date
+( i.e. format YYYYMMddHHMMSSffff ) or as a relative time
+( e.g. format &#8216;5m&#8217; or &#8216;10s&#8217;). 
+If the date is a relative time and the dbase parameter 
+is given (dbase must be datetime object), the returned
+date will be dbase + sdate. If dbase is None, 
+current time will be used instead as base time.</p>
+<p>:param date : string date  
+:type date : date</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.timefuncs.stformat">
+<tt class="descclassname">nepi.util.timefuncs.</tt><tt class="descname">stformat</tt><big>(</big><em>sdate</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/timefuncs.html#stformat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.timefuncs.stformat" title="Permalink to this definition">¶</a></dt>
+<dd><p>Constructs a datetime object from a string date with
+format YYYYMMddHHMMSSffff</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.timefuncs.tdiff">
+<tt class="descclassname">nepi.util.timefuncs.</tt><tt class="descname">tdiff</tt><big>(</big><em>date1</em>, <em>date2</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/timefuncs.html#tdiff"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.timefuncs.tdiff" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns difference ( date1 - date2 ) as a datetime object,
+where date1 and date 2 are datetime objects</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.timefuncs.tdiffsec">
+<tt class="descclassname">nepi.util.timefuncs.</tt><tt class="descname">tdiffsec</tt><big>(</big><em>date1</em>, <em>date2</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/timefuncs.html#tdiffsec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.timefuncs.tdiffsec" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the date difference ( date1 - date2 ) in seconds,
+where date1 and date 2 are datetime objects</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.timefuncs.tnow">
+<tt class="descclassname">nepi.util.timefuncs.</tt><tt class="descname">tnow</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/util/timefuncs.html#tnow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.timefuncs.tnow" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns datetime object with the current time</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="nepi.util.timefuncs.tsformat">
+<tt class="descclassname">nepi.util.timefuncs.</tt><tt class="descname">tsformat</tt><big>(</big><em>date=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/util/timefuncs.html#tsformat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.util.timefuncs.tsformat" title="Permalink to this definition">¶</a></dt>
+<dd><p>Formats a datetime object to a string with format YYYYMMddHHMMSSffff.
+If no date is given, the current date is used.</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.util">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nepi.util" title="Permalink to this headline">¶</a></h2>
+</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.2 documentation</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