PyPI - quarchpy - Versions diffs - 2.2.10.dev1__py2.py3-none-any.whl → 2.2.12__py2.py3-none-any.whl - Mend

quarchpy 2.2.10.dev1py2.py3-none-any.whl → 2.2.12py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1164) hide show

quarchpy/docs/_build/html/source/quarchpy.iometer.html CHANGED Viewed

@@ -1,272 +1,272 @@
-<!DOCTYPE html>
-<html lang="en" data-content_root="../">
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
-    <title>quarchpy.iometer package &#8212; quarchpy  documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
-    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
-    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
-    <script src="../_static/doctools.js?v=9bcbadda"></script>
-    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
-    <link rel="index" title="Index" href="../genindex.html" />
-    <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="quarchpy.user_interface package" href="quarchpy.user_interface.html" />
-    <link rel="prev" title="quarchpy.fio package" href="quarchpy.fio.html" />
-  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
-  </head><body>
-    <div class="document">
-      <div class="documentwrapper">
-        <div class="bodywrapper">
-          <div class="body" role="main">
-  <section id="quarchpy-iometer-package">
-<h1>quarchpy.iometer package<a class="headerlink" href="#quarchpy-iometer-package" title="Link to this heading">¶</a></h1>
-<section id="submodules">
-<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
-</section>
-<section id="module-quarchpy.iometer.iometerFuncs">
-<span id="quarchpy-iometer-iometerfuncs-module"></span><h2>quarchpy.iometer.iometerFuncs module<a class="headerlink" href="#module-quarchpy.iometer.iometerFuncs" title="Link to this heading">¶</a></h2>
-<p>This contains useful functions for Iometer automation with Quarch tools</p>
-<p>########### VERSION HISTORY ###########</p>
-<p>13/08/2018 - Andy Norrie    - First version, based on initial work from Pedro Leao
-20/02/2023 - Matt Holsey    - Updating for App note overhaul, improving documentation</p>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.followResultsFile">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">followResultsFile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theFile</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.followResultsFile" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.generateIcfFromConf">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">generateIcfFromConf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">confPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driveInfo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">managerName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'QAS0521'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.generateIcfFromConf" title="Link to this definition">¶</a></dt>
-<dd><p>Scans the given path for .conf files (ioMeter template files) and
-creates .icf files with the correct host and drive target information in place</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>confPath</strong> – String         - Path to /conf</p></li>
-<li><p><strong>driveInfo</strong> – Dictionary    - Dict with 3 keys: NAME, DRIVE, FW_REV</p></li>
-<li><p><strong>managerName</strong> – String      - String of the current system name</p></li>
-</ul>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>N/A</p>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.generateIcfFromCsvLineData">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">generateIcfFromCsvLineData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">csvData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">icfFilePath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driveInfo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">managerName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'QAS0521'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.generateIcfFromCsvLineData" title="Link to this definition">¶</a></dt>
-<dd><p>Takes a CSV data dictionary and creates an .icf file at the given path. DriveInfo and optional manager name are
-used to specify the target and host within the file</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>csvData</strong> – Dictionary      - Row read from CSV</p></li>
-<li><p><strong>icfFilePath</strong> – String      - File path for the new file</p></li>
-<li><p><strong>driveInfo</strong> – Dictionary    - Dict with 3 keys: NAME, DRIVE, FW_REV</p></li>
-<li><p><strong>managerName</strong> – String      - Name of System</p></li>
-</ul>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.processIometerInstResults">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">processIometerInstResults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">testName</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">userCallbacks</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.processIometerInstResults" title="Link to this definition">¶</a></dt>
-<dd><p>This function follows the data accumulating from Iometer, in the instant results file, and
-processes it into QPS, adding annotationsa and custom channel data points as needed.</p>
-<p>This currently assumes that custom channels have been created for IOPS, Data and Response</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>testName</strong></p></li>
-<li><p><strong>myStream</strong></p></li>
-<li><p><strong>userCallbacks</strong></p></li>
-</ul>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p></p>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.readIcfCsvLineData">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">readIcfCsvLineData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">csvFileName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">csvFileLine</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.readIcfCsvLineData" title="Link to this definition">¶</a></dt>
-<dd><p>Reads the given CSV file which must be formatter for Iometer .icf data (One header, no blank rows).
-Reads the data into a dictionary</p>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.runIOMeter">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">runIOMeter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">fileName</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.runIOMeter" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-</section>
-<section id="module-quarchpy.iometer">
-<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.iometer" title="Link to this heading">¶</a></h2>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.iometer.generateIcfFromConf">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.</span></span><span class="sig-name descname"><span class="pre">generateIcfFromConf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">confPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driveInfo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">managerName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'QAS0521'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.generateIcfFromConf" title="Link to this definition">¶</a></dt>
-<dd><p>Scans the given path for .conf files (ioMeter template files) and
-creates .icf files with the correct host and drive target information in place</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>confPath</strong> – String         - Path to /conf</p></li>
-<li><p><strong>driveInfo</strong> – Dictionary    - Dict with 3 keys: NAME, DRIVE, FW_REV</p></li>
-<li><p><strong>managerName</strong> – String      - String of the current system name</p></li>
-</ul>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>N/A</p>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.iometer.generateIcfFromCsvLineData">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.</span></span><span class="sig-name descname"><span class="pre">generateIcfFromCsvLineData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">csvData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">icfFilePath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driveInfo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">managerName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'QAS0521'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.generateIcfFromCsvLineData" title="Link to this definition">¶</a></dt>
-<dd><p>Takes a CSV data dictionary and creates an .icf file at the given path. DriveInfo and optional manager name are
-used to specify the target and host within the file</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>csvData</strong> – Dictionary      - Row read from CSV</p></li>
-<li><p><strong>icfFilePath</strong> – String      - File path for the new file</p></li>
-<li><p><strong>driveInfo</strong> – Dictionary    - Dict with 3 keys: NAME, DRIVE, FW_REV</p></li>
-<li><p><strong>managerName</strong> – String      - Name of System</p></li>
-</ul>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.iometer.processIometerInstResults">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.</span></span><span class="sig-name descname"><span class="pre">processIometerInstResults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">testName</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">userCallbacks</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.processIometerInstResults" title="Link to this definition">¶</a></dt>
-<dd><p>This function follows the data accumulating from Iometer, in the instant results file, and
-processes it into QPS, adding annotationsa and custom channel data points as needed.</p>
-<p>This currently assumes that custom channels have been created for IOPS, Data and Response</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>testName</strong></p></li>
-<li><p><strong>myStream</strong></p></li>
-<li><p><strong>userCallbacks</strong></p></li>
-</ul>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p></p>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.iometer.readIcfCsvLineData">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.</span></span><span class="sig-name descname"><span class="pre">readIcfCsvLineData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">csvFileName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">csvFileLine</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.readIcfCsvLineData" title="Link to this definition">¶</a></dt>
-<dd><p>Reads the given CSV file which must be formatter for Iometer .icf data (One header, no blank rows).
-Reads the data into a dictionary</p>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.iometer.runIOMeter">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.</span></span><span class="sig-name descname"><span class="pre">runIOMeter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">fileName</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.runIOMeter" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-</section>
-</section>
-          </div>
-        </div>
-      </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
-        <div class="sphinxsidebarwrapper">
-<h1 class="logo"><a href="../index.html">quarchpy</a></h1>
-<search id="searchbox" style="display: none" role="search">
-    <div class="searchformwrapper">
-    <form class="search" action="../search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
-      <input type="submit" value="Go" />
-    </form>
-    </div>
-</search>
-<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
-<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
-<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog (Quarchpy)</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="modules.html">quarchpy</a><ul class="current">
-<li class="toctree-l2 current"><a class="reference internal" href="quarchpy.html">quarchpy package</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="readme.html">Quarchpy - Readme</a></li>
-<li class="toctree-l1"><a class="reference internal" href="licenses.html">LICENSES</a></li>
-</ul>
-<div class="relations">
-<h3>Related Topics</h3>
-<ul>
-  <li><a href="../index.html">Documentation overview</a><ul>
-  <li><a href="modules.html">quarchpy</a><ul>
-  <li><a href="quarchpy.html">quarchpy package</a><ul>
-      <li>Previous: <a href="quarchpy.fio.html" title="previous chapter">quarchpy.fio package</a></li>
-      <li>Next: <a href="quarchpy.user_interface.html" title="next chapter">quarchpy.user_interface package</a></li>
-  </ul></li>
-  </ul></li>
-  </ul></li>
-</ul>
-</div>
-        </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="footer">
-      &#169;2020, Quarch Technology Ltd.
-      |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
-      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
-      |
-      <a href="../_sources/source/quarchpy.iometer.rst.txt"
-          rel="nofollow">Page source</a>
-    </div>
-  </body>
+<!DOCTYPE html>
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>quarchpy.iometer package &#8212; quarchpy  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="quarchpy.user_interface package" href="quarchpy.user_interface.html" />
+    <link rel="prev" title="quarchpy.fio package" href="quarchpy.fio.html" />
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+  </head><body>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+  <section id="quarchpy-iometer-package">
+<h1>quarchpy.iometer package<a class="headerlink" href="#quarchpy-iometer-package" title="Link to this heading">¶</a></h1>
+<section id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
+</section>
+<section id="module-quarchpy.iometer.iometerFuncs">
+<span id="quarchpy-iometer-iometerfuncs-module"></span><h2>quarchpy.iometer.iometerFuncs module<a class="headerlink" href="#module-quarchpy.iometer.iometerFuncs" title="Link to this heading">¶</a></h2>
+<p>This contains useful functions for Iometer automation with Quarch tools</p>
+<p>########### VERSION HISTORY ###########</p>
+<p>13/08/2018 - Andy Norrie    - First version, based on initial work from Pedro Leao
+20/02/2023 - Matt Holsey    - Updating for App note overhaul, improving documentation</p>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.followResultsFile">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">followResultsFile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theFile</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.followResultsFile" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.generateIcfFromConf">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">generateIcfFromConf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">confPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driveInfo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">managerName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'QAS0521'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.generateIcfFromConf" title="Link to this definition">¶</a></dt>
+<dd><p>Scans the given path for .conf files (ioMeter template files) and
+creates .icf files with the correct host and drive target information in place</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>confPath</strong> – String         - Path to /conf</p></li>
+<li><p><strong>driveInfo</strong> – Dictionary    - Dict with 3 keys: NAME, DRIVE, FW_REV</p></li>
+<li><p><strong>managerName</strong> – String      - String of the current system name</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>N/A</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.generateIcfFromCsvLineData">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">generateIcfFromCsvLineData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">csvData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">icfFilePath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driveInfo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">managerName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'QAS0521'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.generateIcfFromCsvLineData" title="Link to this definition">¶</a></dt>
+<dd><p>Takes a CSV data dictionary and creates an .icf file at the given path. DriveInfo and optional manager name are
+used to specify the target and host within the file</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>csvData</strong> – Dictionary      - Row read from CSV</p></li>
+<li><p><strong>icfFilePath</strong> – String      - File path for the new file</p></li>
+<li><p><strong>driveInfo</strong> – Dictionary    - Dict with 3 keys: NAME, DRIVE, FW_REV</p></li>
+<li><p><strong>managerName</strong> – String      - Name of System</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.processIometerInstResults">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">processIometerInstResults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">testName</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">userCallbacks</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.processIometerInstResults" title="Link to this definition">¶</a></dt>
+<dd><p>This function follows the data accumulating from Iometer, in the instant results file, and
+processes it into QPS, adding annotationsa and custom channel data points as needed.</p>
+<p>This currently assumes that custom channels have been created for IOPS, Data and Response</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>testName</strong></p></li>
+<li><p><strong>myStream</strong></p></li>
+<li><p><strong>userCallbacks</strong></p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p></p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.readIcfCsvLineData">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">readIcfCsvLineData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">csvFileName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">csvFileLine</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.readIcfCsvLineData" title="Link to this definition">¶</a></dt>
+<dd><p>Reads the given CSV file which must be formatter for Iometer .icf data (One header, no blank rows).
+Reads the data into a dictionary</p>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.iometer.iometerFuncs.runIOMeter">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.iometerFuncs.</span></span><span class="sig-name descname"><span class="pre">runIOMeter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">fileName</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.iometerFuncs.runIOMeter" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+</section>
+<section id="module-quarchpy.iometer">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.iometer" title="Link to this heading">¶</a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.iometer.generateIcfFromConf">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.</span></span><span class="sig-name descname"><span class="pre">generateIcfFromConf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">confPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driveInfo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">managerName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'QAS0521'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.generateIcfFromConf" title="Link to this definition">¶</a></dt>
+<dd><p>Scans the given path for .conf files (ioMeter template files) and
+creates .icf files with the correct host and drive target information in place</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>confPath</strong> – String         - Path to /conf</p></li>
+<li><p><strong>driveInfo</strong> – Dictionary    - Dict with 3 keys: NAME, DRIVE, FW_REV</p></li>
+<li><p><strong>managerName</strong> – String      - String of the current system name</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>N/A</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.iometer.generateIcfFromCsvLineData">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.</span></span><span class="sig-name descname"><span class="pre">generateIcfFromCsvLineData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">csvData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">icfFilePath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driveInfo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">managerName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'QAS0521'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.generateIcfFromCsvLineData" title="Link to this definition">¶</a></dt>
+<dd><p>Takes a CSV data dictionary and creates an .icf file at the given path. DriveInfo and optional manager name are
+used to specify the target and host within the file</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>csvData</strong> – Dictionary      - Row read from CSV</p></li>
+<li><p><strong>icfFilePath</strong> – String      - File path for the new file</p></li>
+<li><p><strong>driveInfo</strong> – Dictionary    - Dict with 3 keys: NAME, DRIVE, FW_REV</p></li>
+<li><p><strong>managerName</strong> – String      - Name of System</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.iometer.processIometerInstResults">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.</span></span><span class="sig-name descname"><span class="pre">processIometerInstResults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">testName</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">userCallbacks</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.processIometerInstResults" title="Link to this definition">¶</a></dt>
+<dd><p>This function follows the data accumulating from Iometer, in the instant results file, and
+processes it into QPS, adding annotationsa and custom channel data points as needed.</p>
+<p>This currently assumes that custom channels have been created for IOPS, Data and Response</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>testName</strong></p></li>
+<li><p><strong>myStream</strong></p></li>
+<li><p><strong>userCallbacks</strong></p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p></p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.iometer.readIcfCsvLineData">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.</span></span><span class="sig-name descname"><span class="pre">readIcfCsvLineData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">csvFileName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">csvFileLine</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.readIcfCsvLineData" title="Link to this definition">¶</a></dt>
+<dd><p>Reads the given CSV file which must be formatter for Iometer .icf data (One header, no blank rows).
+Reads the data into a dictionary</p>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.iometer.runIOMeter">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.iometer.</span></span><span class="sig-name descname"><span class="pre">runIOMeter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">fileName</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.iometer.runIOMeter" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+</section>
+</section>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">quarchpy</a></h1>
+<search id="searchbox" style="display: none" role="search">
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog (Quarchpy)</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="modules.html">quarchpy</a><ul class="current">
+<li class="toctree-l2 current"><a class="reference internal" href="quarchpy.html">quarchpy package</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="readme.html">Quarchpy - Readme</a></li>
+<li class="toctree-l1"><a class="reference internal" href="licenses.html">LICENSES</a></li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  <li><a href="modules.html">quarchpy</a><ul>
+  <li><a href="quarchpy.html">quarchpy package</a><ul>
+      <li>Previous: <a href="quarchpy.fio.html" title="previous chapter">quarchpy.fio package</a></li>
+      <li>Next: <a href="quarchpy.user_interface.html" title="next chapter">quarchpy.user_interface package</a></li>
+  </ul></li>
+  </ul></li>
+  </ul></li>
+</ul>
+</div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2020, Quarch Technology Ltd.
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
+      |
+      <a href="../_sources/source/quarchpy.iometer.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+  </body>
 </html>

quarchpy 2.2.10.dev1__py2.py3-none-any.whl → 2.2.12__py2.py3-none-any.whl

quarchpy 2.2.10.dev1py2.py3-none-any.whl → 2.2.12py2.py3-none-any.whl