Deploying to gh-pages from @ 19bd753 🚀

Author: gubaidulinvadim

doctrees/api/pyaml.tuning_tools.tune.doctree

@@ -617,15 +617,31 @@ <h1>Source code for pyaml.tuning_tools.tune</h1><div class="highlight"><pre>
 <span class="sd">        wait_time : float</span>
 <span class="sd">            Time to wait in second between 2 iterations</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">__setpoint</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">tune</span><span class="p">)</span>
         <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">iter</span><span class="p">):</span>
             <span class="n">diff_tune</span> <span class="o">=</span> <span class="n">tune</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">readback</span><span class="p">()</span>
-            <span class="nb">str</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__tr</span><span class="o">.</span><span class="n">quads</span><span class="p">()</span><span class="o">.</span><span class="n">strengths</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
-            <span class="nb">str</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__tr</span><span class="o">.</span><span class="n">correct</span><span class="p">(</span><span class="n">diff_tune</span><span class="p">)</span>
-            <span class="bp">self</span><span class="o">.</span><span class="n">__tr</span><span class="o">.</span><span class="n">quads</span><span class="p">()</span><span class="o">.</span><span class="n">strengths</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="nb">str</span><span class="p">)</span>
-            <span class="k">if</span> <span class="n">i</span> <span class="o">&lt;</span> <span class="nb">iter</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span>
-                <span class="c1"># Does not wait on the last iter</span>
-                <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">wait_time</span><span class="p">)</span></div>
+            <span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="nb">iter</span><span class="p">:</span>
+                <span class="n">wait_time</span> <span class="o">=</span> <span class="mi">0</span>  <span class="c1"># do not wait on last iteration</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">diff_tune</span><span class="p">,</span> <span class="n">wait_time</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">__setpoint</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">tune</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="Tune.step">
+<a class="viewcode-back" href="../../../api/pyaml.tuning_tools.tune.html#pyaml.tuning_tools.tune.Tune.step">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">step</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dtune</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">,</span> <span class="n">wait_time</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Step the tune by a delta</span>
+<span class="sd">        Parameters</span>
+<span class="sd">        ----------</span>
+<span class="sd">        dtune : np.array</span>
+<span class="sd">            Delta tune</span>
+<span class="sd">        iter_nb: int</span>
+<span class="sd">        wait_time: float</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">strengths</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__tr</span><span class="o">.</span><span class="n">quads</span><span class="p">()</span><span class="o">.</span><span class="n">strengths</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
+        <span class="n">strengths</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__tr</span><span class="o">.</span><span class="n">correct</span><span class="p">(</span><span class="n">dtune</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">__tr</span><span class="o">.</span><span class="n">quads</span><span class="p">()</span><span class="o">.</span><span class="n">strengths</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">strengths</span><span class="p">)</span>
+        <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">wait_time</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">__setpoint</span> <span class="o">+=</span> <span class="n">dtune</span></div>
 
 
     <span class="nd">@property</span>

doctrees/environment.pickle

@@ -581,6 +581,20 @@
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="pyaml.tuning_tools.tune.Tune.step">
+<span class="sig-name descname"><span class="pre">step</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dtune</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyaml/tuning_tools/tune.html#Tune.step"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyaml.tuning_tools.tune.Tune.step" title="Link to this definition">#</a></dt>
+<dd><p>Step the tune by a delta
+:param dtune: Delta tune
+:type dtune: np.array
+:param iter_nb:
+:type iter_nb: int
+:param wait_time:
+:type wait_time: float</p>
+<dl class="field-list simple">
+</dl>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="pyaml.tuning_tools.tune.Tune.response">
 <em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">response</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyaml.tuning_tools.tune.TuneResponse" title="pyaml.tuning_tools.tune.TuneResponse"><span class="pre">TuneResponse</span></a></em><a class="headerlink" href="#pyaml.tuning_tools.tune.Tune.response" title="Link to this definition">#</a></dt>
@@ -714,6 +728,7 @@
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyaml.tuning_tools.tune.Tune.post_init"><code class="docutils literal notranslate"><span class="pre">Tune.post_init()</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyaml.tuning_tools.tune.Tune.readback"><code class="docutils literal notranslate"><span class="pre">Tune.readback()</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyaml.tuning_tools.tune.Tune.set"><code class="docutils literal notranslate"><span class="pre">Tune.set()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyaml.tuning_tools.tune.Tune.step"><code class="docutils literal notranslate"><span class="pre">Tune.step()</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyaml.tuning_tools.tune.Tune.response"><code class="docutils literal notranslate"><span class="pre">Tune.response</span></code></a></li>
 </ul>
 </li>

html/_modules/pyaml/tuning_tools/tune.html

@@ -2616,6 +2616,8 @@ <h2 id="S">S</h2>
       <li><a href="api/pyaml.diagnostics.chromaticity_monitor.html#pyaml.diagnostics.chromaticity_monitor.ConfigModel.Sleep_between_RFvar">Sleep_between_RFvar (ConfigModel attribute)</a>
 </li>
       <li><a href="api/pyaml.magnet.spline_model.html#pyaml.magnet.spline_model.SplineMagnetModel">SplineMagnetModel (class in pyaml.magnet.spline_model)</a>
+</li>
+      <li><a href="api/pyaml.tuning_tools.tune.html#pyaml.tuning_tools.tune.Tune.step">step() (Tune method)</a>
 </li>
       <li><a href="api/pyaml.magnet.magnet.html#pyaml.magnet.magnet.Magnet.strength">strength (Magnet property)</a>
 </li>