Update documentation

OpenCOMPES · Nov 11, 2024 · b841afc · b841afc
1 parent f07abca
commit b841afc
Show file tree

Hide file tree

Showing 18 changed files with 4,108 additions and 360 deletions.
diff --git a/sed/latest/_modules/sed/loader/sxp/loader.html b/sed/latest/_modules/sed/loader/sxp/loader.html
diff --git a/sed/latest/_sources/tutorial/5_sxp_workflow.ipynb.txt b/sed/latest/_sources/tutorial/5_sxp_workflow.ipynb.txt
diff --git a/sed/latest/_sources/workflows/index.md.txt b/sed/latest/_sources/workflows/index.md.txt
@@ -8,4 +8,5 @@ myst:
 
 ```{toctree}
 ../tutorial/4_hextof_workflow
+../tutorial/5_sxp_workflow.ipynb
 ```
diff --git a/sed/latest/index.html b/sed/latest/index.html
@@ -416,6 +416,7 @@ <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this head
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="workflows/index.html">Workflows</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="tutorial/4_hextof_workflow.html">Tutorial for binning data from the HEXTOF instrument at FLASH</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial/5_sxp_workflow.html">Tutorial for binning data from the SXP instrument at the European XFEL</a></li>
 </ul>
 </li>
 </ul>

diff --git a/sed/latest/objects.inv b/sed/latest/objects.inv
diff --git a/sed/latest/searchindex.js b/sed/latest/searchindex.js
diff --git a/sed/latest/sed/api.html b/sed/latest/sed/api.html
@@ -53,7 +53,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Core" href="core.html" />
-    <link rel="prev" title="Tutorial for binning data from the HEXTOF instrument at FLASH" href="../tutorial/4_hextof_workflow.html" />
+    <link rel="prev" title="Tutorial for binning data from the SXP instrument at the European XFEL" href="../tutorial/5_sxp_workflow.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   <meta name="docsearch:version" content="0.2.1" />
@@ -466,12 +466,12 @@ <h1>API<a class="headerlink" href="#api" title="Permalink to this heading">#</a>
 
 <div class="prev-next-area">
     <a class="left-prev"
-       href="../tutorial/4_hextof_workflow.html"
+       href="../tutorial/5_sxp_workflow.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
-        <p class="prev-next-title">Tutorial for binning data from the HEXTOF instrument at FLASH</p>
+        <p class="prev-next-title">Tutorial for binning data from the SXP instrument at the European XFEL</p>
       </div>
     </a>
     <a class="right-next"

diff --git a/sed/latest/sed/dataset.html b/sed/latest/sed/dataset.html
@@ -694,6 +694,9 @@ <h2>Default datasets.json<a class="headerlink" href="#default-datasets-json" tit
 <span class="w">            </span><span class="s2">&quot;energycal_2020_07_20&quot;</span>
 <span class="w">        </span><span class="p">]</span>
 <span class="w">    </span><span class="p">},</span>
+<span class="w">    </span><span class="nt">&quot;Au_Mica&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
+<span class="w">        </span><span class="nt">&quot;url&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://zenodo.org/records/13952965/files/Au_Mica_SXP.zip&quot;</span>
+<span class="w">    </span><span class="p">},</span>
 <span class="w">    </span><span class="nt">&quot;Test&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
 <span class="w">        </span><span class="nt">&quot;url&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://test.com/files/file.zip&quot;</span><span class="p">,</span>
 <span class="w">        </span><span class="nt">&quot;subdirs&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>

diff --git a/sed/latest/sed/loader.html b/sed/latest/sed/loader.html
@@ -2053,15 +2053,15 @@ <h1>Data loader<a class="headerlink" href="#data-loader" title="Permalink to thi
 
 <dl class="py method">
 <dt class="sig sig-object py" id="sed.loader.sxp.loader.SXPLoader.create_dataframe_per_channel">
-<span class="sig-name descname"><span class="pre">create_dataframe_per_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">h5_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sed/loader/sxp/loader.html#SXPLoader.create_dataframe_per_channel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sed.loader.sxp.loader.SXPLoader.create_dataframe_per_channel" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">create_dataframe_per_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sed/loader/sxp/loader.html#SXPLoader.create_dataframe_per_channel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sed.loader.sxp.loader.SXPLoader.create_dataframe_per_channel" title="Permalink to this definition">#</a></dt>
 <dd><p>Returns a pandas DataFrame for a given channel name from a given file.</p>
 <p>This method takes an h5py.File object <cite>h5_file</cite> and a channel name <cite>channel</cite>, and returns
 a pandas DataFrame containing the data for that channel from the file. The format of the
 DataFrame depends on the channel’s format specified in the configuration.</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>h5_file</strong> (<em>h5py.File</em>) – The h5py.File object representing the HDF5 file.</p></li>
+<li><p><strong>file_path</strong> (<em>Path</em>) – The path to the main HDF5 file.</p></li>
 <li><p><strong>channel</strong> (<em>str</em>) – The name of the channel.</p></li>
 </ul>
 </dd>
@@ -2079,14 +2079,14 @@ <h1>Data loader<a class="headerlink" href="#data-loader" title="Permalink to thi
 
 <dl class="py method">
 <dt class="sig sig-object py" id="sed.loader.sxp.loader.SXPLoader.concatenate_channels">
-<span class="sig-name descname"><span class="pre">concatenate_channels</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">h5_file</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sed/loader/sxp/loader.html#SXPLoader.concatenate_channels"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sed.loader.sxp.loader.SXPLoader.concatenate_channels" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">concatenate_channels</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sed/loader/sxp/loader.html#SXPLoader.concatenate_channels"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sed.loader.sxp.loader.SXPLoader.concatenate_channels" title="Permalink to this definition">#</a></dt>
 <dd><p>Concatenates the channels from the provided h5py.File into a pandas DataFrame.</p>
 <p>This method takes an h5py.File object <cite>h5_file</cite> and concatenates the channels present in
 the file into a single pandas DataFrame. The concatenation is performed based on the
 available channels specified in the configuration.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>h5_file</strong> (<em>h5py.File</em>) – The h5py.File object representing the HDF5 file.</p>
+<dd class="field-odd"><p><strong>file_path</strong> (<em>Path</em>) – The path to the main HDF5 file.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>A concatenated pandas DataFrame containing the channels.</p>

diff --git a/sed/latest/tutorial/1_binning_fake_data.html b/sed/latest/tutorial/1_binning_fake_data.html
diff --git a/sed/latest/tutorial/2_conversion_pipeline_for_example_time-resolved_ARPES_data.html b/sed/latest/tutorial/2_conversion_pipeline_for_example_time-resolved_ARPES_data.html
diff --git a/sed/latest/tutorial/3_metadata_collection_and_export_to_NeXus.html b/sed/latest/tutorial/3_metadata_collection_and_export_to_NeXus.html
diff --git a/sed/latest/tutorial/4_hextof_workflow.html b/sed/latest/tutorial/4_hextof_workflow.html