Deploying to gh-pages from @ 77e345c 🚀

Author: gubaidulinvadim

doctrees/api/pyaml.tuning_tools.orbit.doctree

@@ -496,7 +496,7 @@
 <span id="orbit"></span><h1>orbit<a class="headerlink" href="#module-pyaml.tuning_tools.orbit" title="Link to this heading">#</a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="pyaml.tuning_tools.orbit.ConfigModel">
-<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ConfigModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lattice_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bpm_array_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hcorr_array_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vcorr_array_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">singular_values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_matrix</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyaml/tuning_tools/orbit.html#ConfigModel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyaml.tuning_tools.orbit.ConfigModel" title="Link to this definition">#</a></dt>
+<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ConfigModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lattice_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bpm_array_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hcorr_array_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vcorr_array_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">singular_values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">singular_values_H</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">singular_values_V</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_matrix</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyaml/tuning_tools/orbit.html#ConfigModel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyaml.tuning_tools.orbit.ConfigModel" title="Link to this definition">#</a></dt>
 <dd><p>Bases: <a class="reference internal" href="pyaml.common.element.html#pyaml.common.element.ElementConfigModel" title="pyaml.common.element.ElementConfigModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementConfigModel</span></code></a></p>
 <p>Create a new model by parsing and validating input data from keyword arguments.</p>
 <p>Raises [<cite>ValidationError</cite>][pydantic_core.ValidationError] if the input data cannot be
@@ -521,7 +521,17 @@
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="pyaml.tuning_tools.orbit.ConfigModel.singular_values">
-<span class="sig-name descname"><span class="pre">singular_values</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyaml.tuning_tools.orbit.ConfigModel.singular_values" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">singular_values</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></em><a class="headerlink" href="#pyaml.tuning_tools.orbit.ConfigModel.singular_values" title="Link to this definition">#</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyaml.tuning_tools.orbit.ConfigModel.singular_values_H">
+<span class="sig-name descname"><span class="pre">singular_values_H</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></em><a class="headerlink" href="#pyaml.tuning_tools.orbit.ConfigModel.singular_values_H" title="Link to this definition">#</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyaml.tuning_tools.orbit.ConfigModel.singular_values_V">
+<span class="sig-name descname"><span class="pre">singular_values_V</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></em><a class="headerlink" href="#pyaml.tuning_tools.orbit.ConfigModel.singular_values_V" title="Link to this definition">#</a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
@@ -548,8 +558,27 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="pyaml.tuning_tools.orbit.Orbit.correct">
-<span class="sig-name descname"><span class="pre">correct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reference</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plane</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyaml/tuning_tools/orbit.html#Orbit.correct"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyaml.tuning_tools.orbit.Orbit.correct" title="Link to this definition">#</a></dt>
-<dd><dl class="field-list simple">
+<span class="sig-name descname"><span class="pre">correct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plane</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gain_H</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gain_V</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">singular_values_H</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">singular_values_V</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reference</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyaml/tuning_tools/orbit.html#Orbit.correct"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyaml.tuning_tools.orbit.Orbit.correct" title="Link to this definition">#</a></dt>
+<dd><p>Perform orbit correction using the configured response matrix and corrector
+arrays.</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>reference</strong> (<em>optional</em>) – Optional reference orbit to correct towards. If not specified, corrects
+to zero orbit.</p></li>
+<li><p><strong>gain</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a><em>, </em><em>default 1.0</em>) – Global gain applied to all corrector kicks if per-plane gains are not
+specified.</p></li>
+<li><p><strong>plane</strong> (<em>{'H'</em><em>, </em><em>'V'}</em><em>, </em><em>optional</em>) – Plane to correct. If ‘H’, only horizontal correction is performed.
+If ‘V’, only vertical correction is performed.
+If None (default), both planes are corrected.</p></li>
+<li><p><strong>gain_H</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a><em> or </em><em>ArrayLike</em><em>, </em><em>optional</em>) – Gain(s) for the horizontal plane. Overrides <cite>gain</cite> for H-plane if specified.</p></li>
+<li><p><strong>gain_V</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a><em> or </em><em>ArrayLike</em><em>, </em><em>optional</em>) – Gain(s) for the vertical plane. Overrides <cite>gain</cite> for V-plane if specified.</p></li>
+<li><p><strong>singular_values_H</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a><em>, </em><em>optional</em>) – Number of singular values to use for SVD decomposition in the horizontal
+plane. If not specified, uses the default or configured value.</p></li>
+<li><p><strong>singular_values_V</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a><em>, </em><em>optional</em>) – Number of singular values to use for SVD decomposition in the vertical
+plane. If not specified, uses the default or configured value.</p></li>
+</ul>
+</dd>
 </dl>
 </dd></dl>
 
@@ -622,6 +651,8 @@
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyaml.tuning_tools.orbit.ConfigModel.hcorr_array_name"><code class="docutils literal notranslate"><span class="pre">ConfigModel.hcorr_array_name</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyaml.tuning_tools.orbit.ConfigModel.response_matrix"><code class="docutils literal notranslate"><span class="pre">ConfigModel.response_matrix</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyaml.tuning_tools.orbit.ConfigModel.singular_values"><code class="docutils literal notranslate"><span class="pre">ConfigModel.singular_values</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyaml.tuning_tools.orbit.ConfigModel.singular_values_H"><code class="docutils literal notranslate"><span class="pre">ConfigModel.singular_values_H</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyaml.tuning_tools.orbit.ConfigModel.singular_values_V"><code class="docutils literal notranslate"><span class="pre">ConfigModel.singular_values_V</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyaml.tuning_tools.orbit.ConfigModel.vcorr_array_name"><code class="docutils literal notranslate"><span class="pre">ConfigModel.vcorr_array_name</span></code></a></li>
 </ul>
 </li>

doctrees/environment.pickle

@@ -2600,6 +2600,10 @@ <h2 id="S">S</h2>
       <li><a href="api/pyaml.accelerator.html#pyaml.accelerator.ConfigModel.simulators">simulators (ConfigModel attribute)</a>
 </li>
       <li><a href="api/pyaml.tuning_tools.orbit.html#pyaml.tuning_tools.orbit.ConfigModel.singular_values">singular_values (ConfigModel attribute)</a>
+</li>
+      <li><a href="api/pyaml.tuning_tools.orbit.html#pyaml.tuning_tools.orbit.ConfigModel.singular_values_H">singular_values_H (ConfigModel attribute)</a>
+</li>
+      <li><a href="api/pyaml.tuning_tools.orbit.html#pyaml.tuning_tools.orbit.ConfigModel.singular_values_V">singular_values_V (ConfigModel attribute)</a>
 </li>
       <li><a href="api/pyaml.magnet.skewoctu.html#pyaml.magnet.skewoctu.SkewOctu">SkewOctu (class in pyaml.magnet.skewoctu)</a>
 </li>