Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Feb 24, 2025
1 parent 04d1703 commit 79cd422
Show file tree
Hide file tree
Showing 62 changed files with 892 additions and 829 deletions.
10 changes: 5 additions & 5 deletions sed/latest/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; SED 1.0.0a1.dev3+g47b979b documentation</title>
<title>Overview: module code &#8212; SED 1.0.0a1.dev13+g541d4c8 documentation</title>



Expand Down Expand Up @@ -37,7 +37,7 @@
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../_static/documentation_options.js?v=d4e484fb"></script>
<script src="../_static/documentation_options.js?v=0f41f769"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand All @@ -46,15 +46,15 @@
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/sed/switcher.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev3+g47b979b';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev13+g541d4c8';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.0.0a1.dev3+g47b979b" />
<meta name="docsearch:version" content="1.0.0a1.dev13+g541d4c8" />
</head>


Expand Down Expand Up @@ -116,7 +116,7 @@



<p class="title logo__title">SED 1.0.0a1.dev3+g47b979b documentation</p>
<p class="title logo__title">SED 1.0.0a1.dev13+g541d4c8 documentation</p>

</a></div>

Expand Down
20 changes: 8 additions & 12 deletions sed/latest/_modules/sed/binning/binning.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>sed.binning.binning &#8212; SED 1.0.0a1.dev3+g47b979b documentation</title>
<title>sed.binning.binning &#8212; SED 1.0.0a1.dev13+g541d4c8 documentation</title>



Expand Down Expand Up @@ -37,7 +37,7 @@
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../../../_static/documentation_options.js?v=d4e484fb"></script>
<script src="../../../_static/documentation_options.js?v=0f41f769"></script>
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand All @@ -46,15 +46,15 @@
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/sed/switcher.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev3+g47b979b';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev13+g541d4c8';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.0.0a1.dev3+g47b979b" />
<meta name="docsearch:version" content="1.0.0a1.dev13+g541d4c8" />
</head>


Expand Down Expand Up @@ -116,7 +116,7 @@



<p class="title logo__title">SED 1.0.0a1.dev3+g47b979b documentation</p>
<p class="title logo__title">SED 1.0.0a1.dev13+g541d4c8 documentation</p>

</a></div>

Expand Down Expand Up @@ -887,6 +887,7 @@ <h1>Source code for sed.binning.binning</h1><div class="highlight"><pre>
<span class="n">axis</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">bin_centers</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
<span class="n">time_unit</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwds</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">xr</span><span class="o">.</span><span class="n">DataArray</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get a normalization histogram from a timed dataframe.</span>

Expand All @@ -897,17 +898,12 @@ <h1>Source code for sed.binning.binning</h1><div class="highlight"><pre>
<span class="sd"> histogram.</span>
<span class="sd"> bin_centers (np.ndarray): Bin centers used for binning of the axis.</span>
<span class="sd"> time_unit (float): Time unit the data frame entries are based on.</span>
<span class="sd"> **kwds: Additional keyword arguments passed to the bin_dataframe function.</span>

<span class="sd"> Returns:</span>
<span class="sd"> xr.DataArray: Calculated normalization histogram.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">bins</span> <span class="o">=</span> <span class="n">df</span><span class="p">[</span><span class="n">axis</span><span class="p">]</span><span class="o">.</span><span class="n">map_partitions</span><span class="p">(</span>
<span class="n">pd</span><span class="o">.</span><span class="n">cut</span><span class="p">,</span>
<span class="n">bins</span><span class="o">=</span><span class="n">bin_centers_to_bin_edges</span><span class="p">(</span><span class="n">bin_centers</span><span class="p">),</span>
<span class="p">)</span>

<span class="n">histogram</span> <span class="o">=</span> <span class="n">df</span><span class="p">[</span><span class="n">axis</span><span class="p">]</span><span class="o">.</span><span class="n">groupby</span><span class="p">([</span><span class="n">bins</span><span class="p">])</span><span class="o">.</span><span class="n">count</span><span class="p">()</span><span class="o">.</span><span class="n">compute</span><span class="p">()</span><span class="o">.</span><span class="n">values</span> <span class="o">*</span> <span class="n">time_unit</span>
<span class="c1"># histogram = bin_dataframe(df, axes=[axis], bins=[bin_centers]) * time_unit</span>
<span class="n">histogram</span> <span class="o">=</span> <span class="n">bin_dataframe</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">axes</span><span class="o">=</span><span class="p">[</span><span class="n">axis</span><span class="p">],</span> <span class="n">bins</span><span class="o">=</span><span class="p">[</span><span class="n">bin_centers</span><span class="p">],</span> <span class="o">**</span><span class="n">kwds</span><span class="p">)</span> <span class="o">*</span> <span class="n">time_unit</span>

<span class="n">data_array</span> <span class="o">=</span> <span class="n">xr</span><span class="o">.</span><span class="n">DataArray</span><span class="p">(</span>
<span class="n">data</span><span class="o">=</span><span class="n">histogram</span><span class="p">,</span>
Expand Down
10 changes: 5 additions & 5 deletions sed/latest/_modules/sed/binning/numba_bin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>sed.binning.numba_bin &#8212; SED 1.0.0a1.dev3+g47b979b documentation</title>
<title>sed.binning.numba_bin &#8212; SED 1.0.0a1.dev13+g541d4c8 documentation</title>



Expand Down Expand Up @@ -37,7 +37,7 @@
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../../../_static/documentation_options.js?v=d4e484fb"></script>
<script src="../../../_static/documentation_options.js?v=0f41f769"></script>
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand All @@ -46,15 +46,15 @@
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/sed/switcher.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev3+g47b979b';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev13+g541d4c8';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.0.0a1.dev3+g47b979b" />
<meta name="docsearch:version" content="1.0.0a1.dev13+g541d4c8" />
</head>


Expand Down Expand Up @@ -116,7 +116,7 @@



<p class="title logo__title">SED 1.0.0a1.dev3+g47b979b documentation</p>
<p class="title logo__title">SED 1.0.0a1.dev13+g541d4c8 documentation</p>

</a></div>

Expand Down
10 changes: 5 additions & 5 deletions sed/latest/_modules/sed/binning/utils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>sed.binning.utils &#8212; SED 1.0.0a1.dev3+g47b979b documentation</title>
<title>sed.binning.utils &#8212; SED 1.0.0a1.dev13+g541d4c8 documentation</title>



Expand Down Expand Up @@ -37,7 +37,7 @@
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../../../_static/documentation_options.js?v=d4e484fb"></script>
<script src="../../../_static/documentation_options.js?v=0f41f769"></script>
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand All @@ -46,15 +46,15 @@
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/sed/switcher.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev3+g47b979b';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev13+g541d4c8';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.0.0a1.dev3+g47b979b" />
<meta name="docsearch:version" content="1.0.0a1.dev13+g541d4c8" />
</head>


Expand Down Expand Up @@ -116,7 +116,7 @@



<p class="title logo__title">SED 1.0.0a1.dev3+g47b979b documentation</p>
<p class="title logo__title">SED 1.0.0a1.dev13+g541d4c8 documentation</p>

</a></div>

Expand Down
10 changes: 5 additions & 5 deletions sed/latest/_modules/sed/calibrator/delay.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>sed.calibrator.delay &#8212; SED 1.0.0a1.dev3+g47b979b documentation</title>
<title>sed.calibrator.delay &#8212; SED 1.0.0a1.dev13+g541d4c8 documentation</title>



Expand Down Expand Up @@ -37,7 +37,7 @@
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../../../_static/documentation_options.js?v=d4e484fb"></script>
<script src="../../../_static/documentation_options.js?v=0f41f769"></script>
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand All @@ -46,15 +46,15 @@
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/sed/switcher.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev3+g47b979b';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev13+g541d4c8';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.0.0a1.dev3+g47b979b" />
<meta name="docsearch:version" content="1.0.0a1.dev13+g541d4c8" />
</head>


Expand Down Expand Up @@ -116,7 +116,7 @@



<p class="title logo__title">SED 1.0.0a1.dev3+g47b979b documentation</p>
<p class="title logo__title">SED 1.0.0a1.dev13+g541d4c8 documentation</p>

</a></div>

Expand Down
10 changes: 5 additions & 5 deletions sed/latest/_modules/sed/calibrator/energy.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>sed.calibrator.energy &#8212; SED 1.0.0a1.dev3+g47b979b documentation</title>
<title>sed.calibrator.energy &#8212; SED 1.0.0a1.dev13+g541d4c8 documentation</title>



Expand Down Expand Up @@ -37,7 +37,7 @@
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../../../_static/documentation_options.js?v=d4e484fb"></script>
<script src="../../../_static/documentation_options.js?v=0f41f769"></script>
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand All @@ -46,15 +46,15 @@
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/sed/switcher.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev3+g47b979b';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev13+g541d4c8';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.0.0a1.dev3+g47b979b" />
<meta name="docsearch:version" content="1.0.0a1.dev13+g541d4c8" />
</head>


Expand Down Expand Up @@ -116,7 +116,7 @@



<p class="title logo__title">SED 1.0.0a1.dev3+g47b979b documentation</p>
<p class="title logo__title">SED 1.0.0a1.dev13+g541d4c8 documentation</p>

</a></div>

Expand Down
10 changes: 5 additions & 5 deletions sed/latest/_modules/sed/calibrator/momentum.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>sed.calibrator.momentum &#8212; SED 1.0.0a1.dev3+g47b979b documentation</title>
<title>sed.calibrator.momentum &#8212; SED 1.0.0a1.dev13+g541d4c8 documentation</title>



Expand Down Expand Up @@ -37,7 +37,7 @@
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../../../_static/documentation_options.js?v=d4e484fb"></script>
<script src="../../../_static/documentation_options.js?v=0f41f769"></script>
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand All @@ -46,15 +46,15 @@
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/sed/switcher.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev3+g47b979b';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.0.0a1.dev13+g541d4c8';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.0.0a1.dev3+g47b979b" />
<meta name="docsearch:version" content="1.0.0a1.dev13+g541d4c8" />
</head>


Expand Down Expand Up @@ -116,7 +116,7 @@



<p class="title logo__title">SED 1.0.0a1.dev3+g47b979b documentation</p>
<p class="title logo__title">SED 1.0.0a1.dev13+g541d4c8 documentation</p>

</a></div>

Expand Down
Loading

0 comments on commit 79cd422

Please sign in to comment.