Deploying to gh-pages from @ 08d2548 🚀

Author: JoschD

_modules/omc3/harpy/handler.html

@@ -279,14 +279,15 @@ <h1>Source code for omc3.harpy.handler</h1><div class="highlight"><pre>
 <div class="viewcode-block" id="run_per_bunch">
 <a class="viewcode-back" href="../../../modules/harpy.html#omc3.harpy.handler.run_per_bunch">[docs]</a>
 <span class="k">def</span><span class="w"> </span><span class="nf">run_per_bunch</span><span class="p">(</span>
-    <span class="n">tbt_data</span><span class="p">:</span> <span class="n">TbtData</span><span class="p">,</span> <span class="n">harpy_input</span><span class="p">:</span> <span class="n">DotDict</span><span class="p">,</span> <span class="n">file</span><span class="p">:</span> <span class="n">Path</span>
+    <span class="n">tbt_data</span><span class="p">:</span> <span class="n">TbtData</span><span class="p">,</span> <span class="n">harpy_input</span><span class="p">:</span> <span class="n">DotDict</span><span class="p">,</span> <span class="n">output_filename</span><span class="p">:</span> <span class="nb">str</span>
 <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">tfs</span><span class="o">.</span><span class="n">TfsDataFrame</span><span class="p">]:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Cleans data, analyses frequencies and searches for resonances.</span>
 
 <span class="sd">    Args:</span>
 <span class="sd">        tbt_data: single bunch `TbtData`.</span>
 <span class="sd">        harpy_input: Analysis settings taken from the commandline.</span>
+<span class="sd">        output_filename: Name of the output files (placed in `harpy_input.outputdir`).</span>
 
 <span class="sd">    Returns:</span>
 <span class="sd">        Dictionary with a `TfsDataFrame` per plane.</span>
@@ -296,7 +297,7 @@ <h1>Source code for omc3.harpy.handler</h1><div class="highlight"><pre>
         <span class="n">model</span> <span class="o">=</span> <span class="n">tfs</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">harpy_input</span><span class="o">.</span><span class="n">model</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">COL_NAME</span><span class="p">)</span><span class="o">.</span><span class="n">loc</span><span class="p">[:,</span> <span class="n">COL_S</span><span class="p">]</span>
 
     <span class="n">bpm_datas</span><span class="p">,</span> <span class="n">usvs</span><span class="p">,</span> <span class="n">lins</span><span class="p">,</span> <span class="n">bad_bpms</span> <span class="o">=</span> <span class="p">{},</span> <span class="p">{},</span> <span class="p">{},</span> <span class="p">{}</span>
-    <span class="n">output_file_path</span> <span class="o">=</span> <span class="n">harpy_input</span><span class="o">.</span><span class="n">outputdir</span> <span class="o">/</span> <span class="n">file</span><span class="o">.</span><span class="n">name</span>
+    <span class="n">output_file_path</span> <span class="o">=</span> <span class="n">harpy_input</span><span class="o">.</span><span class="n">outputdir</span> <span class="o">/</span> <span class="n">output_filename</span>
 
     <span class="k">for</span> <span class="n">plane</span> <span class="ow">in</span> <span class="n">PLANES</span><span class="p">:</span>
         <span class="n">bpm_data</span> <span class="o">=</span> <span class="n">_get_cut_tbt_matrix</span><span class="p">(</span><span class="n">tbt_data</span><span class="p">,</span> <span class="n">harpy_input</span><span class="o">.</span><span class="n">turns</span><span class="p">,</span> <span class="n">plane</span><span class="p">)</span>

_modules/omc3/hole_in_one.html

@@ -299,7 +299,8 @@ <h2>Hole in One<a class="headerlink" href="#hole-in-one" title="Link to this hea
 </ul>
 </dd>
 <dt>Harpy Kwargs:</dt><dd><ul>
-<li><p><strong>files</strong>: TbT files to analyse</p>
+<li><p><strong>files</strong>: TbT files to analyse.
+Can also be the TbtData objects directly, if ‘tbt_data’ is chosen as datatype.</p>
 <p>Flags: <strong>--files</strong>
 Required: <code class="docutils literal notranslate"><span class="pre">True</span></code></p>
 </li>

entrypoints/analysis.doctree

@@ -440,13 +440,14 @@ <h2>Handler<a class="headerlink" href="#handler" title="Link to this heading">
 </section>
 <dl class="py function">
 <dt class="sig sig-object py">
-<span class="sig-prename descclassname"><span class="pre">omc3.harpy.handler.</span></span><span class="sig-name descname"><span class="pre">run_per_bunch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tbt_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">TbtData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">harpy_input</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DotDict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Path</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">tfs.TfsDataFrame</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/omc3/harpy/handler.html#run_per_bunch"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">omc3.harpy.handler.</span></span><span class="sig-name descname"><span class="pre">run_per_bunch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tbt_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">TbtData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">harpy_input</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DotDict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">tfs.TfsDataFrame</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/omc3/harpy/handler.html#run_per_bunch"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Cleans data, analyses frequencies and searches for resonances.</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>tbt_data</strong> -- single bunch <cite>TbtData</cite>.</p></li>
 <li><p><strong>harpy_input</strong> -- Analysis settings taken from the commandline.</p></li>
+<li><p><strong>output_filename</strong> -- Name of the output files (placed in <cite>harpy_input.outputdir</cite>).</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>