add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _layout / nepi.resources.all.html
diff --git a/doc/sphinx/_build/html/_layout/nepi.resources.all.html b/doc/sphinx/_build/html/_layout/nepi.resources.all.html
new file mode 100644 (file)
index 0000000..ec59dd7
--- /dev/null
@@ -0,0 +1,165 @@
+<!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.resources.all package &mdash; NEPI 3.0 documentation</title>
+    
+    <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '3.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <link rel="top" title="NEPI 3.0 documentation" href="../index.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../index.html">NEPI 3.0 documentation</a> &raquo;</li> 
+      </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.resources.all package</a><ul>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#module-nepi.resources.all.collector">nepi.resources.all.collector module</a></li>
+<li><a class="reference internal" href="#module-nepi.resources.all">Module contents</a></li>
+</ul>
+</li>
+</ul>
+
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../_sources/_layout/nepi.resources.all.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-resources-all-package">
+<h1>nepi.resources.all package<a class="headerlink" href="#nepi-resources-all-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="module-nepi.resources.all.collector">
+<span id="nepi-resources-all-collector-module"></span><h2>nepi.resources.all.collector module<a class="headerlink" href="#module-nepi.resources.all.collector" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="nepi.resources.all.collector.Collector">
+<em class="property">class </em><tt class="descclassname">nepi.resources.all.collector.</tt><tt class="descname">Collector</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/all/collector.html#Collector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.all.collector.Collector" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="nepi.execution.html#nepi.execution.resource.ResourceManager" title="nepi.execution.resource.ResourceManager"><tt class="xref py py-class docutils literal"><span class="pre">nepi.execution.resource.ResourceManager</span></tt></a></p>
+<p>The collector entity is reponsible of collecting traces
+of a same type associated to RMs into a local directory.</p>
+<dl class="class">
+<dt>
+<tt class="descname">Class Args :</tt></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>ec</strong> (<em>ExperimentController</em>) &#8211; The Experiment controller</li>
+<li><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; guid of the RM</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="nepi.resources.all.collector.Collector.do_deploy">
+<tt class="descname">do_deploy</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/all/collector.html#Collector.do_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.all.collector.Collector.do_deploy" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.resources.all.collector.Collector.do_provision">
+<tt class="descname">do_provision</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/all/collector.html#Collector.do_provision"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.all.collector.Collector.do_provision" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.resources.all.collector.Collector.do_release">
+<tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/all/collector.html#Collector.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.all.collector.Collector.do_release" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="nepi.resources.all.collector.Collector.store_path">
+<tt class="descname">store_path</tt><a class="reference internal" href="../_modules/nepi/resources/all/collector.html#Collector.store_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.all.collector.Collector.store_path" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="nepi.resources.all.collector.Collector.valid_connection">
+<tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/all/collector.html#Collector.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.all.collector.Collector.valid_connection" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-nepi.resources.all">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nepi.resources.all" 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.0 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