Skip to content

Commit

Permalink
Update docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 8, 2024
1 parent 3ba234d commit 2bfde1a
Show file tree
Hide file tree
Showing 19 changed files with 385 additions and 103 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified _downloads/90f956a0ec1a60c2f96c8c92607d6fea/plot_residual.zip
Binary file not shown.
Binary file modified _images/sphx_glr_simple_arctan_fit_001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/sphx_glr_simple_arctan_fit_thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions _sources/auto_examples/model_fitting/plot_residual.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -110,15 +110,15 @@ Fit for all navigation positions:

.. code-block:: none
Exception ignored in: <function tqdm.__del__ at 0x7f295e410fe0>
Exception ignored in: <function tqdm.__del__ at 0x7f1bdfc18fe0>
Traceback (most recent call last):
File "/opt/hostedtoolcache/Python/3.11.10/x64/lib/python3.11/site-packages/tqdm/std.py", line 1148, in __del__
self.close()
File "/opt/hostedtoolcache/Python/3.11.10/x64/lib/python3.11/site-packages/tqdm/notebook.py", line 279, in close
self.disp(bar_style='danger', check_delay=False)
^^^^^^^^^
AttributeError: 'tqdm_notebook' object has no attribute 'disp'
0%| | 0/10 [00:00<?, ?it/s] 100%|██████████| 10/10 [00:00<00:00, 1479.73it/s]
0%| | 0/10 [00:00<?, ?it/s] 100%|██████████| 10/10 [00:00<00:00, 1459.60it/s]



Expand Down Expand Up @@ -164,7 +164,7 @@ sphinx_gallery_thumbnail_number = 2

.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 0.510 seconds)
**Total running time of the script:** (0 minutes 0.459 seconds)


.. _sphx_glr_download_auto_examples_model_fitting_plot_residual.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**00:17.236** total execution time for 3 files **from auto_examples/model_fitting**:
**01:11.011** total execution time for 3 files **from auto_examples/model_fitting**:

.. container::

Expand All @@ -33,11 +33,11 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_model_fitting_EELS_curve_fitting.py` (``EELS_curve_fitting.py``)
- 00:16.391
- 01:10.231
- 0.0
* - :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``plot_residual.py``)
- 00:00.510
- 00:00.459
- 0.0
* - :ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py` (``simple_arctan_fit.py``)
- 00:00.334
- 00:00.320
- 0.0
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ Fit an arctan function.
Active: True
Parameter Name | Free | Value | Std | Min | Max | Linear
============== | ======= | ========== | ========== | ========== | ========== | ======
A | True | 1.00200300 | 0.00215862 | None | None | True
k | True | 1.06117418 | 0.09395251 | None | None | False
x0 | True | -0.0149800 | 0.07753129 | None | None | False
A | True | 0.99787428 | 0.00210341 | None | None | True
k | True | 1.06973806 | 0.09302499 | None | None | False
x0 | True | -0.0604308 | 0.07562163 | None | None | False
Expand Down Expand Up @@ -91,7 +91,7 @@ Fit an arctan function.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 0.334 seconds)
**Total running time of the script:** (0 minutes 0.320 seconds)


.. _sphx_glr_download_auto_examples_model_fitting_simple_arctan_fit.py:
Expand Down
8 changes: 4 additions & 4 deletions _sources/sg_execution_times.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**00:17.236** total execution time for 3 files **from all galleries**:
**01:11.011** total execution time for 3 files **from all galleries**:

.. container::

Expand All @@ -33,11 +33,11 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_model_fitting_EELS_curve_fitting.py` (``../examples/model_fitting/EELS_curve_fitting.py``)
- 00:16.391
- 01:10.231
- 0.0
* - :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``../examples/model_fitting/plot_residual.py``)
- 00:00.510
- 00:00.459
- 0.0
* - :ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py` (``../examples/model_fitting/simple_arctan_fit.py``)
- 00:00.334
- 00:00.320
- 0.0
360 changes: 318 additions & 42 deletions auto_examples/model_fitting/EELS_curve_fitting.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions auto_examples/model_fitting/plot_residual.html
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><a href="https://hyperspy.org/hyperspy-doc/current/reference/base_classes/model/basemodel.html#hyperspy.model.BaseModel.multifit" title="hyperspy.model.BaseModel.multifit" class="sphx-glr-backref-module-hyperspy-model sphx-glr-backref-type-py-method"><span class="n">m</span><span class="o">.</span><span class="n">multifit</span></a><span class="p">()</span>
</pre></div>
</div>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>Exception ignored in: &lt;function tqdm.__del__ at 0x7f295e410fe0&gt;
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>Exception ignored in: &lt;function tqdm.__del__ at 0x7f1bdfc18fe0&gt;
Traceback (most recent call last):
File &quot;/opt/hostedtoolcache/Python/3.11.10/x64/lib/python3.11/site-packages/tqdm/std.py&quot;, line 1148, in __del__
self.close()
Expand All @@ -508,7 +508,7 @@
AttributeError: &#39;tqdm_notebook&#39; object has no attribute &#39;disp&#39;

0%| | 0/10 [00:00&lt;?, ?it/s]
100%|██████████| 10/10 [00:00&lt;00:00, 1479.73it/s]
100%|██████████| 10/10 [00:00&lt;00:00, 1459.60it/s]
</pre></div>
</div>
<p>Plot the fitted model with residual:</p>
Expand All @@ -520,7 +520,7 @@
<li><img src="../../_images/sphx_glr_plot_residual_002.png" srcset="../../_images/sphx_glr_plot_residual_002.png" alt="Signal" class = "sphx-glr-multi-img"/></li>
</ul>
<p>sphinx_gallery_thumbnail_number = 2</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.510 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.459 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-model-fitting-plot-residual-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../../_downloads/971c2906ad663020c2e6701928a24c9a/plot_residual.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">plot_residual.ipynb</span></code></a></p>
Expand Down
8 changes: 4 additions & 4 deletions auto_examples/model_fitting/sg_execution_times.html
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@

<section id="computation-times">
<span id="sphx-glr-auto-examples-model-fitting-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Link to this heading">#</a></h1>
<p><strong>00:17.236</strong> total execution time for 3 files <strong>from auto_examples/model_fitting</strong>:</p>
<p><strong>01:11.011</strong> total execution time for 3 files <strong>from auto_examples/model_fitting</strong>:</p>
<div class="docutils container">
<style scoped>
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
Expand All @@ -468,15 +468,15 @@
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference internal" href="EELS_curve_fitting.html#sphx-glr-auto-examples-model-fitting-eels-curve-fitting-py"><span class="std std-ref">EELS curve fitting</span></a> (<code class="docutils literal notranslate"><span class="pre">EELS_curve_fitting.py</span></code>)</p></td>
<td><p>00:16.391</p></td>
<td><p>01:10.231</p></td>
<td><p>0.0</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="plot_residual.html#sphx-glr-auto-examples-model-fitting-plot-residual-py"><span class="std std-ref">Plot Residual</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_residual.py</span></code>)</p></td>
<td><p>00:00.510</p></td>
<td><p>00:00.459</p></td>
<td><p>0.0</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="simple_arctan_fit.html#sphx-glr-auto-examples-model-fitting-simple-arctan-fit-py"><span class="std std-ref">Simple arctan fit</span></a> (<code class="docutils literal notranslate"><span class="pre">simple_arctan_fit.py</span></code>)</p></td>
<td><p>00:00.334</p></td>
<td><p>00:00.320</p></td>
<td><p>0.0</p></td>
</tr>
</tbody>
Expand Down
8 changes: 4 additions & 4 deletions auto_examples/model_fitting/simple_arctan_fit.html
Original file line number Diff line number Diff line change
Expand Up @@ -480,9 +480,9 @@
Active: True
Parameter Name | Free | Value | Std | Min | Max | Linear
============== | ======= | ========== | ========== | ========== | ========== | ======
A | True | 1.00200300 | 0.00215862 | None | None | True
k | True | 1.06117418 | 0.09395251 | None | None | False
x0 | True | -0.0149800 | 0.07753129 | None | None | False
A | True | 0.99787428 | 0.00210341 | None | None | True
k | True | 1.06973806 | 0.09302499 | None | None | False
x0 | True | -0.0604308 | 0.07562163 | None | None | False
</pre></div>
</div>
<div class="line-block">
Expand Down Expand Up @@ -519,7 +519,7 @@
<a href="https://hyperspy.org/hyperspy-doc/current/reference/base_classes/model/model1d.html#hyperspy.models.model1d.Model1D.plot" title="hyperspy.models.model1d.Model1D.plot" class="sphx-glr-backref-module-hyperspy-models-model1d sphx-glr-backref-type-py-method"><span class="n">m</span><span class="o">.</span><span class="n">plot</span></a><span class="p">()</span>
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.334 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.320 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-model-fitting-simple-arctan-fit-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../../_downloads/9fccdf8a75923677d25708442159bb9b/simple_arctan_fit.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">simple_arctan_fit.ipynb</span></code></a></p>
Expand Down
60 changes: 33 additions & 27 deletions changes.html
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,12 @@ <h3>Bug Fixes<a class="headerlink" href="#bug-fixes" title="Link to this heading
<li><p>suspend plot when fitting background. (<a class="reference external" href="https://github.com/hyperspy/exspy/issues/76">#76</a>)</p></li>
</ul>
</li>
<li><p>Plot background and integration windows fixes and improvements:</p>
<ul>
<li><p>fix plotting windows with navigation dimension &gt;=2,</p></li>
<li><p>raise improved error message when windows are out of the range of the signal, (<a class="reference external" href="https://github.com/hyperspy/exspy/issues/86">#86</a>)</p></li>
</ul>
</li>
</ul>
</section>
<section id="improved-documentation">
Expand All @@ -492,32 +498,32 @@ <h3>Improved Documentation<a class="headerlink" href="#improved-documentation" t
</ul>
</section>
</section>
<section id="id7">
<h2>0.2.1 (2024-07-12)<a class="headerlink" href="#id7" title="Link to this heading">#</a></h2>
<section id="id8">
<h3>Bug Fixes<a class="headerlink" href="#id8" title="Link to this heading">#</a></h3>
<h2>0.2.1 (2024-07-12)<a class="headerlink" href="#id8" title="Link to this heading">#</a></h2>
<section id="id9">
<h3>Bug Fixes<a class="headerlink" href="#id9" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Fix gradients of the <a class="reference internal" href="reference/components.html#exspy.components.EELSArctan" title="exspy.components.EELSArctan"><code class="xref py py-class docutils literal notranslate"><span class="pre">EELSArctan</span></code></a> component. (<a class="reference external" href="https://github.com/hyperspy/exspy/issues/55">#55</a>)</p></li>
<li><p>Fix blocked eelsdb queries (<a class="reference external" href="https://github.com/hyperspy/exspy/issues/66">#66</a>)</p></li>
</ul>
</section>
<section id="id11">
<h3>Improved Documentation<a class="headerlink" href="#id11" title="Link to this heading">#</a></h3>
<section id="id12">
<h3>Improved Documentation<a class="headerlink" href="#id12" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Fix broken links in the documentation and missing docstring of the <a class="reference internal" href="reference/components.html#exspy.components.PESCoreLineShape" title="exspy.components.PESCoreLineShape"><code class="xref py py-class docutils literal notranslate"><span class="pre">PESCoreLineShape</span></code></a> component in the API reference. (<a class="reference external" href="https://github.com/hyperspy/exspy/issues/55">#55</a>)</p></li>
</ul>
</section>
</section>
<section id="id13">
<h2>0.2 (2024-04-10)<a class="headerlink" href="#id13" title="Link to this heading">#</a></h2>
<section id="id14">
<h3>Bug Fixes<a class="headerlink" href="#id14" title="Link to this heading">#</a></h3>
<h2>0.2 (2024-04-10)<a class="headerlink" href="#id14" title="Link to this heading">#</a></h2>
<section id="id15">
<h3>Bug Fixes<a class="headerlink" href="#id15" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Fix restoring Gosh and Hartree Slater GOS from stored models. (<a class="reference external" href="https://github.com/hyperspy/exspy/issues/32">#32</a>)</p></li>
</ul>
</section>
<section id="id16">
<h3>Improved Documentation<a class="headerlink" href="#id16" title="Link to this heading">#</a></h3>
<section id="id17">
<h3>Improved Documentation<a class="headerlink" href="#id17" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Add eXSpy logo and adapt spelling to capital X (<a class="reference external" href="https://github.com/hyperspy/exspy/issues/22">#22</a>)</p></li>
<li><p>Fix DOI and add more badges to readme file. (<a class="reference external" href="https://github.com/hyperspy/exspy/issues/36">#36</a>, <a class="reference external" href="https://github.com/hyperspy/exspy/issues/38">#38</a>)</p></li>
Expand All @@ -531,10 +537,10 @@ <h3>Maintenance<a class="headerlink" href="#maintenance" title="Link to this hea
</ul>
</section>
</section>
<section id="id22">
<h2>0.1 (2023-12-03)<a class="headerlink" href="#id22" title="Link to this heading">#</a></h2>
<section id="id23">
<h3>New features<a class="headerlink" href="#id23" title="Link to this heading">#</a></h3>
<h2>0.1 (2023-12-03)<a class="headerlink" href="#id23" title="Link to this heading">#</a></h2>
<section id="id24">
<h3>New features<a class="headerlink" href="#id24" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Support for tabulated <a class="reference internal" href="user_guide/eels.html#eels-gos"><span class="std std-ref">Generalised Oscillator Strengths (GOS)</span></a> using the
<a class="reference external" href="https://gitlab.com/gguzzina/gosh">GOSH</a> open file format. By default, a freely
Expand All @@ -543,14 +549,14 @@ <h3>New features<a class="headerlink" href="#id23" title="Link to this heading">
<li><p>Add functionality to fit the <a class="reference internal" href="user_guide/eels.html#eels-fine-structure"><span class="std std-ref">EELS fine structure</span></a> using components, e.g. <a class="reference external" href="https://hyperspy.org/hyperspy-doc/current/reference/api.model/components1D.html#hyperspy.api.model.components1D.Gaussian" title="(in HyperSpy v2.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">hyperspy.api.model.components1D.Gaussian</span></code></a>. (<a class="reference external" href="https://github.com/hyperspy/hyperspy/issues/3206">HyperSpy #3206</a>)</p></li>
</ul>
</section>
<section id="id24">
<h3>Enhancements<a class="headerlink" href="#id24" title="Link to this heading">#</a></h3>
<section id="id25">
<h3>Enhancements<a class="headerlink" href="#id25" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Enable <code class="docutils literal notranslate"><span class="pre">signal_range</span></code> arguments when using <code class="docutils literal notranslate"><span class="pre">subpixel=True</span></code> in <a class="reference internal" href="reference/signals.html#exspy.signals.EELSSpectrum.align_zero_loss_peak" title="exspy.signals.EELSSpectrum.align_zero_loss_peak"><code class="xref py py-meth docutils literal notranslate"><span class="pre">align_zero_loss_peak()</span></code></a> (<a class="reference external" href="https://github.com/hyperspy/exspy/pull/7">#7</a>)</p></li>
</ul>
</section>
<section id="id26">
<h3>Maintenance<a class="headerlink" href="#id26" title="Link to this heading">#</a></h3>
<section id="id27">
<h3>Maintenance<a class="headerlink" href="#id27" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Use towncrier to manage release notes and improve setting dev version (<a class="reference external" href="https://github.com/hyperspy/exspy/issues/14">#14</a>)</p></li>
<li><p>Use reusable workflow from the hyperspy organisation for the doc workflow (<a class="reference external" href="https://github.com/hyperspy/exspy/pull/13">#13</a>)</p></li>
Expand Down Expand Up @@ -626,21 +632,21 @@ <h2>Initiation (2023-10-28)<a class="headerlink" href="#initiation-2023-10-28" t
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#improved-documentation">Improved Documentation</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#id7">0.2.1 (2024-07-12)</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id8">Bug Fixes</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id11">Improved Documentation</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#id8">0.2.1 (2024-07-12)</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id9">Bug Fixes</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id12">Improved Documentation</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#id13">0.2 (2024-04-10)</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id14">Bug Fixes</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id16">Improved Documentation</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#id14">0.2 (2024-04-10)</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id15">Bug Fixes</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id17">Improved Documentation</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#maintenance">Maintenance</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#id22">0.1 (2023-12-03)</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id23">New features</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id24">Enhancements</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id26">Maintenance</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#id23">0.1 (2023-12-03)</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id24">New features</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id25">Enhancements</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id27">Maintenance</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#initiation-2023-10-28">Initiation (2023-10-28)</a></li>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

Loading

0 comments on commit 2bfde1a

Please sign in to comment.