recompiling docs for new version

momentoscope · Dec 10, 2020 · 25a273d · 25a273d
1 parent 264e8f0
commit 25a273d
Show file tree

Hide file tree

Showing 54 changed files with 391 additions and 293 deletions.
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/doctrees/example/01_readdaq.doctree b/docs/doctrees/example/01_readdaq.doctree
diff --git a/docs/doctrees/example/02_parquet.doctree b/docs/doctrees/example/02_parquet.doctree
diff --git a/docs/doctrees/example/03_binning.doctree b/docs/doctrees/example/03_binning.doctree
diff --git a/docs/doctrees/example/04_nobinning.doctree b/docs/doctrees/example/04_nobinning.doctree
diff --git a/docs/doctrees/example/05_corrections.doctree b/docs/doctrees/example/05_corrections.doctree
diff --git a/docs/doctrees/example/06_fullexample.doctree b/docs/doctrees/example/06_fullexample.doctree
diff --git a/docs/doctrees/index.doctree b/docs/doctrees/index.doctree
diff --git a/docs/doctrees/library/DldFlashDataframeCreator.doctree b/docs/doctrees/library/DldFlashDataframeCreator.doctree
diff --git a/docs/doctrees/library/DldProcessor.doctree b/docs/doctrees/library/DldProcessor.doctree
diff --git a/docs/doctrees/library/pah.doctree b/docs/doctrees/library/pah.doctree
diff --git a/docs/doctrees/library/utils/calibration.doctree b/docs/doctrees/library/utils/calibration.doctree
diff --git a/docs/doctrees/library/utils/diagnostics.doctree b/docs/doctrees/library/utils/diagnostics.doctree
diff --git a/docs/doctrees/library/utils/io.doctree b/docs/doctrees/library/utils/io.doctree
diff --git a/docs/doctrees/library/utils/masking.doctree b/docs/doctrees/library/utils/masking.doctree
diff --git a/docs/doctrees/library/utils/misc.doctree b/docs/doctrees/library/utils/misc.doctree
diff --git a/docs/doctrees/library/utils/vis.doctree b/docs/doctrees/library/utils/vis.doctree
diff --git a/docs/doctrees/misc/howtomaintain.doctree b/docs/doctrees/misc/howtomaintain.doctree
diff --git a/docs/doctrees/misc/listofterms.doctree b/docs/doctrees/misc/listofterms.doctree
diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 4fc514694dd16c42db05f20f7bccf070
+config: eba9baad041dd5c812d690ed0fb15975
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/_modules/index.html b/docs/html/_modules/index.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>Overview: module code &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 

diff --git a/docs/html/_modules/processor/DldFlashDataframeCreator.html b/docs/html/_modules/processor/DldFlashDataframeCreator.html
diff --git a/docs/html/_modules/processor/DldProcessor.html b/docs/html/_modules/processor/DldProcessor.html
diff --git a/docs/html/_modules/processor/pah.html b/docs/html/_modules/processor/pah.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>processor.pah &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>processor.pah &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 
@@ -259,6 +259,7 @@ <h1>Source code for processor.pah</h1><div class="highlight"><pre>
                <span class="ow">or</span> <span class="n">channelName</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/Experiment/&#39;</span><span class="p">)</span> \
                <span class="ow">or</span> <span class="n">channelName</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/Photon Diagnostic/&#39;</span><span class="p">)</span> \
                <span class="ow">or</span> <span class="n">channelName</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/Electron Diagnostic/&#39;</span><span class="p">)</span> \
+               <span class="ow">or</span> <span class="n">channelName</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/Beamlines/&#39;</span><span class="p">)</span> \
                <span class="ow">or</span> <span class="n">channelName</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/Timing/&#39;</span><span class="p">)</span>  <span class="c1"># &lt;--for datasets before 08-2018</span></div></div>
 
 

diff --git a/docs/html/_modules/processor/utilities/calibration.html b/docs/html/_modules/processor/utilities/calibration.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>processor.utilities.calibration &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>processor.utilities.calibration &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 

diff --git a/docs/html/_modules/processor/utilities/diagnostics.html b/docs/html/_modules/processor/utilities/diagnostics.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>processor.utilities.diagnostics &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>processor.utilities.diagnostics &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 

diff --git a/docs/html/_modules/processor/utilities/io.html b/docs/html/_modules/processor/utilities/io.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>processor.utilities.io &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>processor.utilities.io &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 
@@ -239,7 +239,7 @@ <h1>Source code for processor.utilities.io</h1><div class="highlight"><pre>
     <span class="n">_abort</span> <span class="o">=</span> <span class="kc">False</span>
 
     <span class="k">if</span> <span class="n">path</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
-        <span class="n">path</span> <span class="o">=</span> <span class="n">misc</span><span class="o">.</span><span class="n">parse_setting</span><span class="p">(</span><span class="s1">&#39;paths&#39;</span><span class="p">,</span> <span class="s1">&#39;DATA_H5_DIR&#39;</span><span class="p">)</span>
+        <span class="n">path</span> <span class="o">=</span> <span class="n">misc</span><span class="o">.</span><span class="n">parse_setting</span><span class="p">(</span><span class="s1">&#39;paths&#39;</span><span class="p">,</span> <span class="s1">&#39;DATA_H5_DIR&#39;</span><span class="p">)</span> <span class="c1">#TODO: generalise to get path from any settings, as in processor.</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>  <span class="c1"># test if the path exists...</span>
         <span class="n">answer</span> <span class="o">=</span> <span class="nb">input</span><span class="p">(</span><span class="s2">&quot;The folder </span><span class="si">{}</span><span class="s2"> doesn&#39;t exist,&quot;</span>
                        <span class="s2">&quot;do you want to create it? [y/n]&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">path</span><span class="p">))</span>

diff --git a/docs/html/_modules/processor/utilities/misc.html b/docs/html/_modules/processor/utilities/misc.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>processor.utilities.misc &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>processor.utilities.misc &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 
@@ -604,7 +604,7 @@ <h1>Source code for processor.utilities.misc</h1><div class="highlight"><pre>
     <span class="k">try</span><span class="p">:</span>
         <span class="k">return</span> <span class="p">(</span><span class="n">available_runs</span><span class="p">[</span><span class="s1">&#39;run</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">runNumber</span><span class="p">)])</span>
     <span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
-        <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="s1">&#39;No run number </span><span class="si">{}</span><span class="s1"> under path </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">runNumber</span><span class="p">,</span> <span class="n">rootpath</span><span class="p">))</span></div>
+        <span class="k">raise</span> <span class="ne">FileNotFoundError</span><span class="p">(</span><span class="s1">&#39;No run number </span><span class="si">{}</span><span class="s1"> under path </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">runNumber</span><span class="p">,</span> <span class="n">rootpath</span><span class="p">))</span></div>
 
 
 <span class="k">def</span> <span class="nf">availableParquet</span><span class="p">(</span><span class="n">parquet_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>

diff --git a/docs/html/_modules/processor/utilities/vis.html b/docs/html/_modules/processor/utilities/vis.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>processor.utilities.vis &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>processor.utilities.vis &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 

diff --git a/docs/html/_static/documentation_options.js b/docs/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.0.2',
+    VERSION: '1.0.3',
     LANGUAGE: 'English',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/html/_static/pygments.css b/docs/html/_static/pygments.css
@@ -1,8 +1,8 @@
 pre { line-height: 125%; margin: 0; }
-td.linenos pre { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
-span.linenos { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
-td.linenos pre.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
-span.linenos.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
+td.linenos pre { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
+td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .highlight .hll { background-color: #ffffcc }
 .highlight { background: #eeffcc; }
 .highlight .c { color: #408090; font-style: italic } /* Comment */

diff --git a/docs/html/example/01_readdaq.html b/docs/html/example/01_readdaq.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>1. Read DAQ data &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>1. Read DAQ data &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 

diff --git a/docs/html/example/02_parquet.html b/docs/html/example/02_parquet.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>2. Save dataset to dask parquet files &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>2. Save dataset to dask parquet files &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 

diff --git a/docs/html/example/03_binning.html b/docs/html/example/03_binning.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>3. Binning multidimensional data &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>3. Binning multidimensional data &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 

diff --git a/docs/html/example/04_nobinning.html b/docs/html/example/04_nobinning.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>4. Processing data without binning &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>4. Processing data without binning &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 

diff --git a/docs/html/example/05_corrections.html b/docs/html/example/05_corrections.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>5. Corrections to FEL pulse timing &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>5. Corrections to FEL pulse timing &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 

diff --git a/docs/html/example/06_fullexample.html b/docs/html/example/06_fullexample.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>6. Complete code examples &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>6. Complete code examples &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 

diff --git a/docs/html/genindex.html b/docs/html/genindex.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Index &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>Index &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 
@@ -537,20 +537,18 @@ <h2 id="R">R</h2>
       <li><a href="library/DldFlashDataframeCreator.html#processor.DldFlashDataframeCreator.DldFlashProcessor.readData_old">readData_old() (processor.DldFlashDataframeCreator.DldFlashProcessor method)</a>
 </li>
       <li><a href="library/DldProcessor.html#processor.DldProcessor.DldProcessor.readDataframes">readDataframes() (processor.DldProcessor.DldProcessor method)</a>
-</li>
-      <li><a href="library/DldProcessor.html#processor.DldProcessor.DldProcessor.readDataframesParquet">readDataframesParquet() (processor.DldProcessor.DldProcessor method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="library/DldProcessor.html#processor.DldProcessor.DldProcessor.readDataframesParquet">readDataframesParquet() (processor.DldProcessor.DldProcessor method)</a>
+</li>
       <li><a href="library/DldFlashDataframeCreator.html#processor.DldFlashDataframeCreator.DldFlashProcessor.readInterval">readInterval() (processor.DldFlashDataframeCreator.DldFlashProcessor method)</a>
 </li>
       <li><a href="library/DldFlashDataframeCreator.html#processor.DldFlashDataframeCreator.DldFlashProcessor.readRun">readRun() (processor.DldFlashDataframeCreator.DldFlashProcessor method)</a>
 </li>
       <li><a href="library/utils/misc.html#processor.utilities.misc.repr_byte_size">repr_byte_size() (in module processor.utilities.misc)</a>
 </li>
       <li><a href="library/utils/io.html#processor.utilities.io.res_to_xarray">res_to_xarray() (in module processor.utilities.io)</a>
-</li>
-      <li><a href="library/DldProcessor.html#processor.DldProcessor.DldProcessor.res_to_xarray_old">res_to_xarray_old() (processor.DldProcessor.DldProcessor method)</a>
 </li>
       <li><a href="library/DldProcessor.html#processor.DldProcessor.DldProcessor.resetBins">resetBins() (processor.DldProcessor.DldProcessor method)</a>
 </li>
@@ -572,6 +570,8 @@ <h2 id="S">S</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="library/DldProcessor.html#processor.DldProcessor.DldProcessor.setDefaultSettings">setDefaultSettings() (processor.DldProcessor.DldProcessor method)</a>
+</li>
       <li><a href="library/DldProcessor.html#processor.DldProcessor.DldProcessor.settings">settings() (processor.DldProcessor.DldProcessor property)</a>
 </li>
       <li><a href="library/DldProcessor.html#processor.DldProcessor.SettingsInitializationError">SettingsInitializationError</a>

diff --git a/docs/html/index.html b/docs/html/index.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>hextof-processor documentation &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>hextof-processor documentation &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
 
 

diff --git a/docs/html/library/DldFlashDataframeCreator.html b/docs/html/library/DldFlashDataframeCreator.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>1. Dataframe creator class (DldFlashDataframeCreator) &mdash; hextof-processor 1.0.2 documentation</title>
+  <title>1. Dataframe creator class (DldFlashDataframeCreator) &mdash; hextof-processor 1.0.3 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                1.0.2
+                1.0.3
               </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,7 @@ @@
       <meta name="viewport" content="width=device-width, initial-scale=1.0">
-      <title>Overview: module code &mdash; hextof-processor 1.0.2 documentation</title>
+      <title>Overview: module code &mdash; hextof-processor 1.0.3 documentation</title>
@@ Expand Down Expand Up / @@ -60,7 +60,7 @@ @@
                   <div class="version">
-.0.2
+.0.3
                   </div>
@@ Expand Down @@