quarchpy 2.1.24.dev1__py2.py3-none-any.whl → 2.1.24.dev3__py2.py3-none-any.whl

quarchpy/docs/_build/html/source/quarchpy.disk_test.html

@@ -34,11 +34,41 @@
 <section id="submodules">
 <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
 </section>
-<section id="quarchpy-disk-test-absdiskfinder-module">
-<h2>quarchpy.disk_test.AbsDiskFinder module<a class="headerlink" href="#quarchpy-disk-test-absdiskfinder-module" title="Link to this heading">¶</a></h2>
-</section>
-<section id="quarchpy-disk-test-disktargetselection-module">
-<h2>quarchpy.disk_test.DiskTargetSelection module<a class="headerlink" href="#quarchpy-disk-test-disktargetselection-module" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.disk_test.AbsDiskFinder">
+<span id="quarchpy-disk-test-absdiskfinder-module"></span><h2>quarchpy.disk_test.AbsDiskFinder module<a class="headerlink" href="#module-quarchpy.disk_test.AbsDiskFinder" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="quarchpy.disk_test.AbsDiskFinder.AbsDiskFinder">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.disk_test.AbsDiskFinder.</span></span><span class="sig-name descname"><span class="pre">AbsDiskFinder</span></span><a class="headerlink" href="#quarchpy.disk_test.AbsDiskFinder.AbsDiskFinder" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.disk_test.AbsDiskFinder.AbsDiskFinder.findDevices">
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">findDevices</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.disk_test.AbsDiskFinder.AbsDiskFinder.findDevices" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.disk_test.AbsDiskFinder.AbsDiskFinder.formatList">
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">formatList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deviceList</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.disk_test.AbsDiskFinder.AbsDiskFinder.formatList" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.disk_test.AbsDiskFinder.AbsDiskFinder.returnDisk">
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">returnDisk</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.disk_test.AbsDiskFinder.AbsDiskFinder.returnDisk" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</section>
+<section id="module-quarchpy.disk_test.DiskTargetSelection">
+<span id="quarchpy-disk-test-disktargetselection-module"></span><h2>quarchpy.disk_test.DiskTargetSelection module<a class="headerlink" href="#module-quarchpy.disk_test.DiskTargetSelection" title="Link to this heading">¶</a></h2>
+<p>This contains useful functions to help with disk target selection</p>
+<p>Ensure installation of wmi and pywin32</p>
+<p>########### VERSION HISTORY ###########</p>
+<p>13/08/2018 - Andy Norrie    - First version, based on initial work from Pedro Leao</p>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.disk_test.DiskTargetSelection.getDiskTargetSelection">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.disk_test.DiskTargetSelection.</span></span><span class="sig-name descname"><span class="pre">getDiskTargetSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">purpose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'iometer'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.disk_test.DiskTargetSelection.getDiskTargetSelection" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 </section>
 <section id="quarchpy-disk-test-usertestexample-module">
 <h2>quarchpy.disk_test.UserTestExample module<a class="headerlink" href="#quarchpy-disk-test-usertestexample-module" title="Link to this heading">¶</a></h2>
@@ -61,8 +91,44 @@
 <section id="quarchpy-disk-test-hotplugtest-module">
 <h2>quarchpy.disk_test.hotPlugTest module<a class="headerlink" href="#quarchpy-disk-test-hotplugtest-module" title="Link to this heading">¶</a></h2>
 </section>
-<section id="quarchpy-disk-test-iometerdiskfinder-module">
-<h2>quarchpy.disk_test.iometerDiskFinder module<a class="headerlink" href="#quarchpy-disk-test-iometerdiskfinder-module" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.disk_test.iometerDiskFinder">
+<span id="quarchpy-disk-test-iometerdiskfinder-module"></span><h2>quarchpy.disk_test.iometerDiskFinder module<a class="headerlink" href="#module-quarchpy.disk_test.iometerDiskFinder" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.disk_test.iometerDiskFinder.</span></span><span class="sig-name descname"><span class="pre">iometerDiskFinder</span></span><a class="headerlink" href="#quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#quarchpy.disk_test.AbsDiskFinder.AbsDiskFinder" title="quarchpy.disk_test.AbsDiskFinder.AbsDiskFinder"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbsDiskFinder</span></code></a></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.findDevices">
+<span class="sig-name descname"><span class="pre">findDevices</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.findDevices" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.formatList">
+<span class="sig-name descname"><span class="pre">formatList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deviceList</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.formatList" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.getAvailableDisks">
+<span class="sig-name descname"><span class="pre">getAvailableDisks</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostDrive</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.getAvailableDisks" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.getAvailableDrives">
+<span class="sig-name descname"><span class="pre">getAvailableDrives</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.getAvailableDrives" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.remove_values_from_list">
+<span class="sig-name descname"><span class="pre">remove_values_from_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.remove_values_from_list" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.returnDisk">
+<span class="sig-name descname"><span class="pre">returnDisk</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.disk_test.iometerDiskFinder.iometerDiskFinder.returnDisk" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
 </section>
 <section id="quarchpy-disk-test-lspci-module">
 <h2>quarchpy.disk_test.lspci module<a class="headerlink" href="#quarchpy-disk-test-lspci-module" title="Link to this heading">¶</a></h2>
@@ -76,8 +142,8 @@
 <section id="quarchpy-disk-test-testline-module">
 <h2>quarchpy.disk_test.testLine module<a class="headerlink" href="#quarchpy-disk-test-testline-module" title="Link to this heading">¶</a></h2>
 </section>
-<section id="module-contents">
-<h2>Module contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.disk_test">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.disk_test" title="Link to this heading">¶</a></h2>
 </section>
 </section>
 

quarchpy/docs/_build/html/source/quarchpy.fio.html

@@ -36,14 +36,75 @@
 <section id="submodules">
 <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
 </section>
-<section id="quarchpy-fio-fio-interface-module">
-<h2>quarchpy.fio.FIO_interface module<a class="headerlink" href="#quarchpy-fio-fio-interface-module" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.fio.FIO_interface">
+<span id="quarchpy-fio-fio-interface-module"></span><h2>quarchpy.fio.FIO_interface module<a class="headerlink" href="#module-quarchpy.fio.FIO_interface" title="Link to this heading">¶</a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.fio.FIO_interface.adjustTime">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.fio.FIO_interface.</span></span><span class="sig-name descname"><span class="pre">adjustTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.fio.FIO_interface.adjustTime" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.fio.FIO_interface.follow">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.fio.FIO_interface.</span></span><span class="sig-name descname"><span class="pre">follow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">thefile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.fio.FIO_interface.follow" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.fio.FIO_interface.return_data">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.fio.FIO_interface.</span></span><span class="sig-name descname"><span class="pre">return_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fioCallbacks</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">myStream</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arguments</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.fio.FIO_interface.return_data" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.fio.FIO_interface.runFIO">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.fio.FIO_interface.</span></span><span class="sig-name descname"><span class="pre">runFIO</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">myStream</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fioCallbacks</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arguments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.fio.FIO_interface.runFIO" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.fio.FIO_interface.start_fio">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.fio.FIO_interface.</span></span><span class="sig-name descname"><span class="pre">start_fio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.fio.FIO_interface.start_fio" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.fio.FIO_interface.timeNow">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.fio.FIO_interface.</span></span><span class="sig-name descname"><span class="pre">timeNow</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.fio.FIO_interface.timeNow" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 </section>
-<section id="quarchpy-fio-fiodiskfinder-module">
-<h2>quarchpy.fio.fioDiskFinder module<a class="headerlink" href="#quarchpy-fio-fiodiskfinder-module" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.fio.fioDiskFinder">
+<span id="quarchpy-fio-fiodiskfinder-module"></span><h2>quarchpy.fio.fioDiskFinder module<a class="headerlink" href="#module-quarchpy.fio.fioDiskFinder" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="quarchpy.fio.fioDiskFinder.fioDiskFinder">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.fio.fioDiskFinder.</span></span><span class="sig-name descname"><span class="pre">fioDiskFinder</span></span><a class="headerlink" href="#quarchpy.fio.fioDiskFinder.fioDiskFinder" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">AbsDiskFinder</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.fio.fioDiskFinder.fioDiskFinder.bytes2human">
+<span class="sig-name descname"><span class="pre">bytes2human</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.fio.fioDiskFinder.fioDiskFinder.bytes2human" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.fio.fioDiskFinder.fioDiskFinder.findDevices">
+<span class="sig-name descname"><span class="pre">findDevices</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.fio.fioDiskFinder.fioDiskFinder.findDevices" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.fio.fioDiskFinder.fioDiskFinder.formatList">
+<span class="sig-name descname"><span class="pre">formatList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deviceList</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.fio.fioDiskFinder.fioDiskFinder.formatList" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.fio.fioDiskFinder.fioDiskFinder.returnDisk">
+<span class="sig-name descname"><span class="pre">returnDisk</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.fio.fioDiskFinder.fioDiskFinder.returnDisk" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
 </section>
-<section id="module-contents">
-<h2>Module contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.fio">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.fio" title="Link to this heading">¶</a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.fio.runFIO">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.fio.</span></span><span class="sig-name descname"><span class="pre">runFIO</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">myStream</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fioCallbacks</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arguments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.fio.runFIO" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 </section>
 </section>