Deploying to gh-pages from @ eb51bad 🚀

Author: JeanLucPons

doctrees/api/pyaml.common.element_holder.doctree

@@ -378,7 +378,9 @@ <h1>Source code for pyaml.common.element_holder</h1><div class="highlight"><pre>
 <span class="kn">from</span><span class="w"> </span><span class="nn">.element</span><span class="w"> </span><span class="kn">import</span> <span class="n">Element</span>
 
 <span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
+    <span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.dispersion</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dispersion</span>
     <span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.orbit</span><span class="w"> </span><span class="kn">import</span> <span class="n">Orbit</span>
+    <span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.orbit_response_matrix</span><span class="w"> </span><span class="kn">import</span> <span class="n">OrbitResponseMatrix</span>
     <span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.tune</span><span class="w"> </span><span class="kn">import</span> <span class="n">Tune</span>
 
 
@@ -727,7 +729,39 @@ <h1>Source code for pyaml.common.element_holder</h1><div class="highlight"><pre>
 
     <span class="nd">@property</span>
     <span class="k">def</span><span class="w"> </span><span class="nf">orbit</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;Orbit&quot;</span><span class="p">:</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_orbit_tuning</span><span class="p">(</span><span class="s2">&quot;DEFAULT_ORBIT_CORRECTION&quot;</span><span class="p">)</span></div>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_orbit_tuning</span><span class="p">(</span><span class="s2">&quot;DEFAULT_ORBIT_CORRECTION&quot;</span><span class="p">)</span>
+
+<div class="viewcode-block" id="ElementHolder.get_orm_tuning">
+<a class="viewcode-back" href="../../../api/pyaml.common.element_holder.html#pyaml.common.element_holder.ElementHolder.get_orm_tuning">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_orm_tuning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;OrbitResponseMatrix&quot;</span><span class="p">:</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get</span><span class="p">(</span><span class="s2">&quot;OrbitResponseMatrix tool&quot;</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__TUNING_TOOLS</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="ElementHolder.add_orm_tuning">
+<a class="viewcode-back" href="../../../api/pyaml.common.element_holder.html#pyaml.common.element_holder.ElementHolder.add_orm_tuning">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">add_orm_tuning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">orm</span><span class="p">:</span> <span class="n">Element</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">__add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__TUNING_TOOLS</span><span class="p">,</span> <span class="n">orm</span><span class="p">)</span></div>
+
+
+    <span class="nd">@property</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">orm</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;OrbitResponseMatrix&quot;</span><span class="p">:</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_orm_tuning</span><span class="p">(</span><span class="s2">&quot;DEFAULT_ORBIT_RESPONSE_MATRIX&quot;</span><span class="p">)</span>
+
+<div class="viewcode-block" id="ElementHolder.get_dispersion_tuning">
+<a class="viewcode-back" href="../../../api/pyaml.common.element_holder.html#pyaml.common.element_holder.ElementHolder.get_dispersion_tuning">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_dispersion_tuning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;Dispersion&quot;</span><span class="p">:</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get</span><span class="p">(</span><span class="s2">&quot;Dispersion tool&quot;</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__TUNING_TOOLS</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="ElementHolder.add_dispersion_tuning">
+<a class="viewcode-back" href="../../../api/pyaml.common.element_holder.html#pyaml.common.element_holder.ElementHolder.add_dispersion_tuning">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">add_dispersion_tuning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dispersion</span><span class="p">:</span> <span class="n">Element</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">__add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__TUNING_TOOLS</span><span class="p">,</span> <span class="n">dispersion</span><span class="p">)</span></div>
+
+
+    <span class="nd">@property</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;Dispersion&quot;</span><span class="p">:</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_dispersion_tuning</span><span class="p">(</span><span class="s2">&quot;DEFAULT_DISPERSION&quot;</span><span class="p">)</span></div>
 
 </pre></div>
 

doctrees/environment.pickle

@@ -390,7 +390,9 @@ <h1>Source code for pyaml.control.controlsystem</h1><div class="highlight"><pre>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..magnet.serialized_magnet</span><span class="w"> </span><span class="kn">import</span> <span class="n">SerializedMagnets</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..rf.rf_plant</span><span class="w"> </span><span class="kn">import</span> <span class="n">RFPlant</span><span class="p">,</span> <span class="n">RWTotalVoltage</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..rf.rf_transmitter</span><span class="w"> </span><span class="kn">import</span> <span class="n">RFTransmitter</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.dispersion</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dispersion</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.orbit</span><span class="w"> </span><span class="kn">import</span> <span class="n">Orbit</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.orbit_response_matrix</span><span class="w"> </span><span class="kn">import</span> <span class="n">OrbitResponseMatrix</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.tune</span><span class="w"> </span><span class="kn">import</span> <span class="n">Tune</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">.deviceaccess</span><span class="w"> </span><span class="kn">import</span> <span class="n">DeviceAccess</span>
 
@@ -689,7 +691,13 @@ <h1>Source code for pyaml.control.controlsystem</h1><div class="highlight"><pre>
                 <span class="bp">self</span><span class="o">.</span><span class="n">add_tune_tuning</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
 
             <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">Orbit</span><span class="p">):</span>
-                <span class="bp">self</span><span class="o">.</span><span class="n">add_orbit_tuning</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
+                <span class="bp">self</span><span class="o">.</span><span class="n">add_orbit_tuning</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
+
+            <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">OrbitResponseMatrix</span><span class="p">):</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">add_orm_tuning</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
+
+            <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">Dispersion</span><span class="p">):</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">add_dispersion_tuning</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
 </div>
 
 </pre></div>

html/_modules/pyaml/common/element_holder.html

@@ -394,7 +394,9 @@ <h1>Source code for pyaml.lattice.simulator</h1><div class="highlight"><pre>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..magnet.serialized_magnet</span><span class="w"> </span><span class="kn">import</span> <span class="n">SerializedMagnets</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..rf.rf_plant</span><span class="w"> </span><span class="kn">import</span> <span class="n">RFPlant</span><span class="p">,</span> <span class="n">RWTotalVoltage</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..rf.rf_transmitter</span><span class="w"> </span><span class="kn">import</span> <span class="n">RFTransmitter</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.dispersion</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dispersion</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.orbit</span><span class="w"> </span><span class="kn">import</span> <span class="n">Orbit</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.orbit_response_matrix</span><span class="w"> </span><span class="kn">import</span> <span class="n">OrbitResponseMatrix</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..tuning_tools.tune</span><span class="w"> </span><span class="kn">import</span> <span class="n">Tune</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">.attribute_linker</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
     <span class="n">ConfigModel</span> <span class="k">as</span> <span class="n">PyAtAttrLinkerConfigModel</span><span class="p">,</span>
@@ -556,7 +558,8 @@ <h1>Source code for pyaml.lattice.simulator</h1><div class="highlight"><pre>
             <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">SerializedMagnets</span><span class="p">):</span>
                 <span class="n">currents</span> <span class="o">=</span> <span class="p">[]</span>
                 <span class="n">strengths</span> <span class="o">=</span> <span class="p">[]</span>
-                <span class="c1"># Create unique refs the series and each of its function for this control system</span>
+                <span class="c1"># Create unique refs the series and each of its function for this</span>
+                <span class="c1"># control system</span>
                 <span class="c1"># Link hardware to strengths and bind strength together</span>
                 <span class="k">for</span> <span class="n">index</span><span class="p">,</span> <span class="n">magnet</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">get_magnets</span><span class="p">()):</span>
                     <span class="n">current</span> <span class="o">=</span> <span class="p">(</span>
@@ -660,7 +663,13 @@ <h1>Source code for pyaml.lattice.simulator</h1><div class="highlight"><pre>
                 <span class="bp">self</span><span class="o">.</span><span class="n">add_tune_tuning</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
 
             <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">Orbit</span><span class="p">):</span>
-                <span class="bp">self</span><span class="o">.</span><span class="n">add_orbit_tuning</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
+                <span class="bp">self</span><span class="o">.</span><span class="n">add_orbit_tuning</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
+
+            <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">OrbitResponseMatrix</span><span class="p">):</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">add_orm_tuning</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
+
+            <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">Dispersion</span><span class="p">):</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">add_dispersion_tuning</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
 
 
 <div class="viewcode-block" id="Simulator.get_names">