Skip to content

Commit b841afc

Browse files
author
github-actions
committed
Update documentation
1 parent f07abca commit b841afc

18 files changed

+4108
-360
lines changed

sed/latest/_modules/sed/loader/sxp/loader.html

Lines changed: 27 additions & 17 deletions
Large diffs are not rendered by default.

sed/latest/_sources/tutorial/5_sxp_workflow.ipynb.txt

Lines changed: 553 additions & 0 deletions
Large diffs are not rendered by default.

sed/latest/_sources/workflows/index.md.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ myst:
88

99
```{toctree}
1010
../tutorial/4_hextof_workflow
11+
../tutorial/5_sxp_workflow.ipynb
1112
```

sed/latest/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,7 @@ <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this head
416416
<ul>
417417
<li class="toctree-l1"><a class="reference internal" href="workflows/index.html">Workflows</a><ul>
418418
<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>
419+
<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>
419420
</ul>
420421
</li>
421422
</ul>

sed/latest/objects.inv

426 Bytes
Binary file not shown.

sed/latest/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sed/latest/sed/api.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
<link rel="index" title="Index" href="../genindex.html" />
5454
<link rel="search" title="Search" href="../search.html" />
5555
<link rel="next" title="Core" href="core.html" />
56-
<link rel="prev" title="Tutorial for binning data from the HEXTOF instrument at FLASH" href="../tutorial/4_hextof_workflow.html" />
56+
<link rel="prev" title="Tutorial for binning data from the SXP instrument at the European XFEL" href="../tutorial/5_sxp_workflow.html" />
5757
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5858
<meta name="docsearch:language" content="en"/>
5959
<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>
466466

467467
<div class="prev-next-area">
468468
<a class="left-prev"
469-
href="../tutorial/4_hextof_workflow.html"
469+
href="../tutorial/5_sxp_workflow.html"
470470
title="previous page">
471471
<i class="fa-solid fa-angle-left"></i>
472472
<div class="prev-next-info">
473473
<p class="prev-next-subtitle">previous</p>
474-
<p class="prev-next-title">Tutorial for binning data from the HEXTOF instrument at FLASH</p>
474+
<p class="prev-next-title">Tutorial for binning data from the SXP instrument at the European XFEL</p>
475475
</div>
476476
</a>
477477
<a class="right-next"

sed/latest/sed/dataset.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -694,6 +694,9 @@ <h2>Default datasets.json<a class="headerlink" href="#default-datasets-json" tit
694694
<span class="w"> </span><span class="s2">&quot;energycal_2020_07_20&quot;</span>
695695
<span class="w"> </span><span class="p">]</span>
696696
<span class="w"> </span><span class="p">},</span>
697+
<span class="w"> </span><span class="nt">&quot;Au_Mica&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
698+
<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>
699+
<span class="w"> </span><span class="p">},</span>
697700
<span class="w"> </span><span class="nt">&quot;Test&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
698701
<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>
699702
<span class="w"> </span><span class="nt">&quot;subdirs&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>

sed/latest/sed/loader.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2053,15 +2053,15 @@ <h1>Data loader<a class="headerlink" href="#data-loader" title="Permalink to thi
20532053

20542054
<dl class="py method">
20552055
<dt class="sig sig-object py" id="sed.loader.sxp.loader.SXPLoader.create_dataframe_per_channel">
2056-
<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>
2056+
<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>
20572057
<dd><p>Returns a pandas DataFrame for a given channel name from a given file.</p>
20582058
<p>This method takes an h5py.File object <cite>h5_file</cite> and a channel name <cite>channel</cite>, and returns
20592059
a pandas DataFrame containing the data for that channel from the file. The format of the
20602060
DataFrame depends on the channel’s format specified in the configuration.</p>
20612061
<dl class="field-list simple">
20622062
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
20632063
<dd class="field-odd"><ul class="simple">
2064-
<li><p><strong>h5_file</strong> (<em>h5py.File</em>) – The h5py.File object representing the HDF5 file.</p></li>
2064+
<li><p><strong>file_path</strong> (<em>Path</em>) – The path to the main HDF5 file.</p></li>
20652065
<li><p><strong>channel</strong> (<em>str</em>) – The name of the channel.</p></li>
20662066
</ul>
20672067
</dd>
@@ -2079,14 +2079,14 @@ <h1>Data loader<a class="headerlink" href="#data-loader" title="Permalink to thi
20792079

20802080
<dl class="py method">
20812081
<dt class="sig sig-object py" id="sed.loader.sxp.loader.SXPLoader.concatenate_channels">
2082-
<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>
2082+
<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>
20832083
<dd><p>Concatenates the channels from the provided h5py.File into a pandas DataFrame.</p>
20842084
<p>This method takes an h5py.File object <cite>h5_file</cite> and concatenates the channels present in
20852085
the file into a single pandas DataFrame. The concatenation is performed based on the
20862086
available channels specified in the configuration.</p>
20872087
<dl class="field-list simple">
20882088
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2089-
<dd class="field-odd"><p><strong>h5_file</strong> (<em>h5py.File</em>) – The h5py.File object representing the HDF5 file.</p>
2089+
<dd class="field-odd"><p><strong>file_path</strong> (<em>Path</em>) – The path to the main HDF5 file.</p>
20902090
</dd>
20912091
<dt class="field-even">Returns<span class="colon">:</span></dt>
20922092
<dd class="field-even"><p>A concatenated pandas DataFrame containing the channels.</p>

sed/latest/tutorial/1_binning_fake_data.html

Lines changed: 38 additions & 38 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)