Deploying to gh-pages from @ f818079 🚀

pylhc · Aug 29, 2023 · 95e0a1c · 95e0a1c
1 parent ccb031c
commit 95e0a1c
Show file tree

Hide file tree

Showing 119 changed files with 2,228 additions and 1,021 deletions.
diff --git a/_modules/index.html b/_modules/index.html
@@ -11,11 +11,11 @@
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../_static/jquery.js"></script>
-        <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-        <script src="../_static/doctools.js"></script>
-        <script src="../_static/sphinx_highlight.js"></script>
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=57cbeb03"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" /> 

diff --git a/_modules/omc3/amplitude_detuning_analysis.html b/_modules/omc3/amplitude_detuning_analysis.html
@@ -11,11 +11,11 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/jquery.js"></script>
-        <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
-        <script src="../../_static/doctools.js"></script>
-        <script src="../../_static/sphinx_highlight.js"></script>
+        <script src="../../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../../_static/documentation_options.js?v=57cbeb03"></script>
+        <script src="../../_static/doctools.js?v=888ff710"></script>
+        <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" /> 
@@ -459,7 +459,9 @@ <h1>Source code for omc3.amplitude_detuning_analysis</h1><div class="highlight">
 <span class="c1"># Main -------------------------------------------------------------------------</span>
 
 
-<div class="viewcode-block" id="analyse_with_bbq_corrections"><a class="viewcode-back" href="../../entrypoints/analysis.html#omc3.amplitude_detuning_analysis.analyse_with_bbq_corrections">[docs]</a><span class="nd">@entrypoint</span><span class="p">(</span><span class="n">_get_params</span><span class="p">(),</span> <span class="n">strict</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+<div class="viewcode-block" id="analyse_with_bbq_corrections">
+<a class="viewcode-back" href="../../entrypoints/analysis.html#omc3.amplitude_detuning_analysis.analyse_with_bbq_corrections">[docs]</a>
+<span class="nd">@entrypoint</span><span class="p">(</span><span class="n">_get_params</span><span class="p">(),</span> <span class="n">strict</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 <span class="k">def</span> <span class="nf">analyse_with_bbq_corrections</span><span class="p">(</span><span class="n">opt</span><span class="p">:</span> <span class="n">DotDict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">TfsDataFrame</span><span class="p">,</span> <span class="n">TfsDataFrame</span><span class="p">]:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Create amplitude detuning analysis with BBQ correction from timber data.</span>
@@ -488,7 +490,10 @@ <h1>Source code for omc3.amplitude_detuning_analysis</h1><div class="highlight">
     <span class="k">return</span> <span class="n">kick_df</span><span class="p">,</span> <span class="n">bbq_df</span></div>
 
 
-<div class="viewcode-block" id="get_kick_and_bbq_df"><a class="viewcode-back" href="../../entrypoints/analysis.html#omc3.amplitude_detuning_analysis.get_kick_and_bbq_df">[docs]</a><span class="k">def</span> <span class="nf">get_kick_and_bbq_df</span><span class="p">(</span><span class="n">kick</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Path</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span> <span class="n">bbq_in</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Path</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span>
+
+<div class="viewcode-block" id="get_kick_and_bbq_df">
+<a class="viewcode-back" href="../../entrypoints/analysis.html#omc3.amplitude_detuning_analysis.get_kick_and_bbq_df">[docs]</a>
+<span class="k">def</span> <span class="nf">get_kick_and_bbq_df</span><span class="p">(</span><span class="n">kick</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Path</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span> <span class="n">bbq_in</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Path</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span>
                         <span class="n">beam</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                         <span class="n">filter_opt</span><span class="p">:</span> <span class="n">FilterOpts</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                         <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</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="n">tfs</span><span class="o">.</span><span class="n">TfsDataFrame</span><span class="p">]:</span>
@@ -528,7 +533,10 @@ <h1>Source code for omc3.amplitude_detuning_analysis</h1><div class="highlight">
     <span class="k">return</span> <span class="n">kick_df</span><span class="p">,</span> <span class="n">bbq_df</span></div>
 
 
-<div class="viewcode-block" id="single_action_analysis"><a class="viewcode-back" href="../../entrypoints/analysis.html#omc3.amplitude_detuning_analysis.single_action_analysis">[docs]</a><span class="k">def</span> <span class="nf">single_action_analysis</span><span class="p">(</span><span class="n">kick_df</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="n">kick_plane</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">detuning_order</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">corrected</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
+
+<div class="viewcode-block" id="single_action_analysis">
+<a class="viewcode-back" href="../../entrypoints/analysis.html#omc3.amplitude_detuning_analysis.single_action_analysis">[docs]</a>
+<span class="k">def</span> <span class="nf">single_action_analysis</span><span class="p">(</span><span class="n">kick_df</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="n">kick_plane</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">detuning_order</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">corrected</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
                            <span class="p">)</span> <span class="o">-&gt;</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;Performs the fit one action and tune pane at a time.&quot;&quot;&quot;</span>
     <span class="n">LOG</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Performing amplitude detuning ODR for single-plane kicks in </span><span class="si">{</span><span class="n">kick_plane</span><span class="si">}</span><span class="s2">.&quot;</span><span class="p">)</span>
@@ -560,7 +568,10 @@ <h1>Source code for omc3.amplitude_detuning_analysis</h1><div class="highlight">
     <span class="k">return</span> <span class="n">kick_df</span></div>
 
 
-<div class="viewcode-block" id="double_action_analysis"><a class="viewcode-back" href="../../entrypoints/analysis.html#omc3.amplitude_detuning_analysis.double_action_analysis">[docs]</a><span class="k">def</span> <span class="nf">double_action_analysis</span><span class="p">(</span><span class="n">kick_df</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="n">detuning_order</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">corrected</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
+
+<div class="viewcode-block" id="double_action_analysis">
+<a class="viewcode-back" href="../../entrypoints/analysis.html#omc3.amplitude_detuning_analysis.double_action_analysis">[docs]</a>
+<span class="k">def</span> <span class="nf">double_action_analysis</span><span class="p">(</span><span class="n">kick_df</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="n">detuning_order</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">corrected</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
                            <span class="p">)</span> <span class="o">-&gt;</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;Performs the full 2D/4D fitting of the data.&quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">detuning_order</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
@@ -601,7 +612,10 @@ <h1>Source code for omc3.amplitude_detuning_analysis</h1><div class="highlight">
     <span class="k">return</span> <span class="n">kick_df</span></div>
 
 
-<div class="viewcode-block" id="get_approx_bbq_interval"><a class="viewcode-back" href="../../entrypoints/analysis.html#omc3.amplitude_detuning_analysis.get_approx_bbq_interval">[docs]</a><span class="k">def</span> <span class="nf">get_approx_bbq_interval</span><span class="p">(</span>
+
+<div class="viewcode-block" id="get_approx_bbq_interval">
+<a class="viewcode-back" href="../../entrypoints/analysis.html#omc3.amplitude_detuning_analysis.get_approx_bbq_interval">[docs]</a>
+<span class="k">def</span> <span class="nf">get_approx_bbq_interval</span><span class="p">(</span>
         <span class="n">bbq_df</span><span class="p">:</span> <span class="n">TfsDataFrame</span><span class="p">,</span> <span class="n">time_array</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">CERNDatetime</span><span class="p">],</span> <span class="n">window</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">CERNDatetime</span><span class="p">,</span> <span class="n">CERNDatetime</span><span class="p">]:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Get approximate start and end times for averaging, based on window length and kick interval.&quot;&quot;&quot;</span>
     <span class="n">bbq_tmp</span> <span class="o">=</span> <span class="n">bbq_df</span><span class="o">.</span><span class="n">dropna</span><span class="p">()</span>
@@ -625,6 +639,7 @@ <h1>Source code for omc3.amplitude_detuning_analysis</h1><div class="highlight">
     <span class="k">return</span> <span class="n">bbq_tmp</span><span class="o">.</span><span class="n">index</span><span class="p">[</span><span class="n">i_start</span><span class="p">],</span> <span class="n">bbq_tmp</span><span class="o">.</span><span class="n">index</span><span class="p">[</span><span class="n">i_end</span><span class="p">]</span></div>
 
 
+
 <span class="c1"># Private Functions ------------------------------------------------------------</span>
 
 

diff --git a/_modules/omc3/check_corrections.html b/_modules/omc3/check_corrections.html
@@ -11,11 +11,11 @@
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="../../_static/jquery.js"></script>
-        <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
-        <script src="../../_static/doctools.js"></script>
-        <script src="../../_static/sphinx_highlight.js"></script>
+        <script src="../../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../../_static/documentation_options.js?v=57cbeb03"></script>
+        <script src="../../_static/doctools.js?v=888ff710"></script>
+        <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" /> 
@@ -523,7 +523,9 @@ <h1>Source code for omc3.check_corrections</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">params</span>
 
 
-<div class="viewcode-block" id="correction_test_entrypoint"><a class="viewcode-back" href="../../entrypoints/correction.html#omc3.check_corrections.correction_test_entrypoint">[docs]</a><span class="nd">@entrypoint</span><span class="p">(</span><span class="n">get_params</span><span class="p">())</span>
+<div class="viewcode-block" id="correction_test_entrypoint">
+<a class="viewcode-back" href="../../entrypoints/correction.html#omc3.check_corrections.correction_test_entrypoint">[docs]</a>
+<span class="nd">@entrypoint</span><span class="p">(</span><span class="n">get_params</span><span class="p">())</span>
 <span class="k">def</span> <span class="nf">correction_test_entrypoint</span><span class="p">(</span><span class="n">opt</span><span class="p">:</span> <span class="n">DotDict</span><span class="p">,</span> <span class="n">accel_opt</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot; Entrypoint function to test the given corrections.</span>
 
@@ -566,6 +568,7 @@ <h1>Source code for omc3.check_corrections</h1><div class="highlight"><pre>
         <span class="n">_do_plots</span><span class="p">(</span><span class="n">corrections</span><span class="p">,</span> <span class="n">opt</span><span class="p">)</span></div>
 
 
+
 <span class="c1"># Input Parameters -------------------------------------------------------------</span>
 
 <span class="k">def</span> <span class="nf">_check_opt_add_dicts</span><span class="p">(</span><span class="n">opt</span><span class="p">:</span> <span class="n">DotDict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DotDict</span><span class="p">:</span>