Update docs build

hyperspy · Mar 31, 2024 · 2c4898f · 2c4898f
1 parent 8ecf220
commit 2c4898f
Show file tree

Hide file tree

Showing 42 changed files with 64 additions and 460 deletions.
diff --git a/.buildinfo b/.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: 47bf694fb161cf4b8278e0766520ec66
+config: 4916b2b26a35ac680a0be53d7dbbb6d9
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/_images/sphx_glr_simple_arctan_fit_001.png b/_images/sphx_glr_simple_arctan_fit_001.png
diff --git a/_images/sphx_glr_simple_arctan_fit_thumb.png b/_images/sphx_glr_simple_arctan_fit_thumb.png
diff --git a/_sources/auto_examples/model_fitting/EELS_curve_fitting.rst.txt b/_sources/auto_examples/model_fitting/EELS_curve_fitting.rst.txt
@@ -38,7 +38,7 @@ png file.
 
  .. code-block:: none
 
-      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]      0%|                                     | 14.3k/42.3M [00:00<08:49, 79.8kB/s]      0%|                                      | 48.1k/42.3M [00:00<04:36, 153kB/s]      0%|                                      | 82.9k/42.3M [00:00<03:53, 181kB/s]      0%|▏                                      | 188k/42.3M [00:00<01:55, 364kB/s]      1%|▍                                      | 410k/42.3M [00:00<00:57, 722kB/s]      2%|▊                                     | 851k/42.3M [00:00<00:29, 1.40MB/s]      4%|█▌                                   | 1.73M/42.3M [00:01<00:14, 2.72MB/s]      8%|███                                  | 3.48M/42.3M [00:01<00:07, 5.29MB/s]     15%|█████▍                               | 6.28M/42.3M [00:01<00:03, 9.03MB/s]     21%|███████▊                             | 8.94M/42.3M [00:01<00:02, 11.3MB/s]     27%|█████████▊                           | 11.2M/42.3M [00:01<00:02, 12.2MB/s]     33%|████████████                         | 13.8M/42.3M [00:01<00:02, 13.3MB/s]     39%|██████████████▎                      | 16.4M/42.3M [00:02<00:01, 14.1MB/s]     45%|████████████████▌                    | 18.9M/42.3M [00:02<00:01, 14.5MB/s]     51%|██████████████████▋                  | 21.4M/42.3M [00:02<00:01, 14.8MB/s]     57%|█████████████████████                | 24.0M/42.3M [00:02<00:01, 15.2MB/s]     63%|███████████████████████▏             | 26.5M/42.3M [00:02<00:01, 15.4MB/s]     69%|█████████████████████████▍           | 29.0M/42.3M [00:02<00:00, 15.4MB/s]     75%|███████████████████████████▋         | 31.6M/42.3M [00:03<00:00, 15.5MB/s]     81%|█████████████████████████████▉       | 34.2M/42.3M [00:03<00:00, 15.6MB/s]     87%|████████████████████████████████▏    | 36.7M/42.3M [00:03<00:00, 15.7MB/s]     93%|██████████████████████████████████▍  | 39.3M/42.3M [00:03<00:00, 15.7MB/s]     99%|████████████████████████████████████▋| 41.9M/42.3M [00:03<00:00, 15.8MB/s]      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]    100%|██████████████████████████████████████| 42.3M/42.3M [00:00<00:00, 270GB/s]
+      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]      0%|                                      | 46.1k/42.3M [00:00<02:06, 334kB/s]      0%|                                       | 114k/42.3M [00:00<01:44, 405kB/s]      1%|▍                                     | 443k/42.3M [00:00<00:32, 1.30MB/s]      3%|▉                                    | 1.06M/42.3M [00:00<00:16, 2.47MB/s]      6%|██                                   | 2.39M/42.3M [00:00<00:07, 5.50MB/s]     12%|████▎                                | 4.94M/42.3M [00:00<00:03, 11.2MB/s]     19%|███████                              | 8.14M/42.3M [00:00<00:01, 17.2MB/s]     26%|█████████▍                           | 10.8M/42.3M [00:00<00:01, 19.0MB/s]     32%|███████████▉                         | 13.7M/42.3M [00:01<00:01, 21.6MB/s]     39%|██████████████▍                      | 16.5M/42.3M [00:01<00:01, 23.5MB/s]     46%|████████████████▉                    | 19.4M/42.3M [00:01<00:00, 25.1MB/s]     52%|███████████████████▎                 | 22.0M/42.3M [00:01<00:00, 23.1MB/s]     59%|█████████████████████▊               | 24.9M/42.3M [00:01<00:00, 24.7MB/s]     66%|████████████████████████▎            | 27.8M/42.3M [00:01<00:00, 26.0MB/s]     73%|██████████████████████████▉          | 30.8M/42.3M [00:01<00:00, 27.1MB/s]     80%|█████████████████████████████▊       | 34.0M/42.3M [00:01<00:00, 28.6MB/s]     87%|████████████████████████████████▎    | 36.9M/42.3M [00:01<00:00, 27.3MB/s]     95%|███████████████████████████████████  | 40.1M/42.3M [00:02<00:00, 28.5MB/s]      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]    100%|██████████████████████████████████████| 42.3M/42.3M [00:00<00:00, 185GB/s]
 
 
 
@@ -68,7 +68,7 @@ png file.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 10.844 seconds)
+   **Total running time of the script:** (0 minutes 8.344 seconds)
 
 
 .. _sphx_glr_download_auto_examples_model_fitting_EELS_curve_fitting.py:

diff --git a/_sources/auto_examples/model_fitting/plot_residual.rst.txt b/_sources/auto_examples/model_fitting/plot_residual.rst.txt
@@ -110,15 +110,15 @@ Fit for all navigation positions:
 
  .. code-block:: none
 
-    Exception ignored in: <function tqdm.__del__ at 0x7f3c9ad9a5c0>
+    Exception ignored in: <function tqdm.__del__ at 0x7f2d1712a5c0>
     Traceback (most recent call last):
       File "/opt/hostedtoolcache/Python/3.11.8/x64/lib/python3.11/site-packages/tqdm/std.py", line 1148, in __del__
         self.close()
       File "/opt/hostedtoolcache/Python/3.11.8/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, 1472.77it/s]
+      0%|          | 0/10 [00:00<?, ?it/s]    100%|██████████| 10/10 [00:00<00:00, 1470.65it/s]
 
 
 
@@ -164,7 +164,7 @@ sphinx_gallery_thumbnail_number = 2
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.528 seconds)
+   **Total running time of the script:** (0 minutes 0.534 seconds)
 
 
 .. _sphx_glr_download_auto_examples_model_fitting_plot_residual.py:

diff --git a/_sources/auto_examples/model_fitting/sg_execution_times.rst.txt b/_sources/auto_examples/model_fitting/sg_execution_times.rst.txt
@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:11.737** total execution time for 3 files **from auto_examples/model_fitting**:
+**00:09.243** total execution time for 3 files **from auto_examples/model_fitting**:
 
 .. container::
 
@@ -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:10.844
+     - 00:08.344
      - 0.0
    * - :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``plot_residual.py``)
-     - 00:00.528
+     - 00:00.534
      - 0.0
    * - :ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py` (``simple_arctan_fit.py``)
-     - 00:00.364
+     - 00:00.366
      - 0.0
diff --git a/_sources/auto_examples/model_fitting/simple_arctan_fit.rst.txt b/_sources/auto_examples/model_fitting/simple_arctan_fit.rst.txt
@@ -42,9 +42,9 @@ Fit an arctan function.
     Active: True
     Parameter Name |    Free |      Value |        Std |        Min |        Max | Linear
     ============== | ======= | ========== | ========== | ========== | ========== | ======
-                 A |    True | 0.99638643 | 0.00223930 |       None |       None |   True
-                 k |    True | 1.02006782 | 0.09212029 |       None |       None |  False
-                x0 |    True | 0.00460140 | 0.08267203 |       None |       None |  False
+                 A |    True | 1.00261675 | 0.00221935 |       None |       None |   True
+                 k |    True | 0.86825264 | 0.07060954 |       None |       None |  False
+                x0 |    True | 0.14303930 | 0.08878233 |       None |       None |  False
 
 
 
@@ -91,7 +91,7 @@ Fit an arctan function.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.364 seconds)
+   **Total running time of the script:** (0 minutes 0.366 seconds)
 
 
 .. _sphx_glr_download_auto_examples_model_fitting_simple_arctan_fit.py:

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -6,7 +6,6 @@
    Examples <auto_examples/index>
    Reference <reference/index>
    Release Notes <changes>
-   Citing <citing>
    Contribute <contributing>
 
 .. include:: intro.rst
diff --git a/_sources/intro.rst.txt b/_sources/intro.rst.txt
@@ -91,6 +91,8 @@ please use the DOI of the specific version that you have employed. You can
 find it by clicking on the DOI badge below.
 
 .. image:: https://zenodo.org/badge/doi/10.5281/zenodo.10252344.svg
+   :class: sd-bg-transparent
+   :alt: doi: 10.5281/zenodo.10252344
    :target: https://zenodo.org/doi/10.5281/zenodo.10252344
 
 Citation in the scientific literature

diff --git a/_sources/sg_execution_times.rst.txt b/_sources/sg_execution_times.rst.txt
@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:11.737** total execution time for 3 files **from all galleries**:
+**00:09.243** total execution time for 3 files **from all galleries**:
 
 .. container::
 
@@ -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:10.844
+     - 00:08.344
      - 0.0
    * - :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``../examples/model_fitting/plot_residual.py``)
-     - 00:00.528
+     - 00:00.534
      - 0.0
    * - :ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py` (``../examples/model_fitting/simple_arctan_fit.py``)
-     - 00:00.364
+     - 00:00.366
      - 0.0
diff --git a/auto_examples/index.html b/auto_examples/index.html
@@ -172,13 +172,6 @@
                     </li>
 
 
-                    <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../citing.html">
-                        Citing
-                      </a>
-                    </li>
-
-
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../contributing.html">
                         Contribute
@@ -323,13 +316,6 @@
                     </li>
 
 
-                    <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../citing.html">
-                        Citing
-                      </a>
-                    </li>
-
-
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../contributing.html">
                         Contribute

diff --git a/auto_examples/model_fitting/EELS_curve_fitting.html b/auto_examples/model_fitting/EELS_curve_fitting.html
@@ -172,13 +172,6 @@
                     </li>
 
 
-                    <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../citing.html">
-                        Citing
-                      </a>
-                    </li>
-
-
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../contributing.html">
                         Contribute
@@ -323,13 +316,6 @@
                     </li>
 
 
-                    <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../citing.html">
-                        Citing
-                      </a>
-                    </li>
-
-
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../contributing.html">
                         Contribute
@@ -471,31 +457,26 @@
 <p>Performs curve fitting to an EELS spectrum, plots the result and saves it as
 png file.</p>
 <img src="../../_images/sphx_glr_EELS_curve_fitting_001.png" srcset="../../_images/sphx_glr_EELS_curve_fitting_001.png" alt="coreloss_spectrum Signal" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>  0%|                                              | 0.00/42.3M [00:00&lt;?, ?B/s]
-  0%|                                     | 14.3k/42.3M [00:00&lt;08:49, 79.8kB/s]
-  0%|                                      | 48.1k/42.3M [00:00&lt;04:36, 153kB/s]
-  0%|                                      | 82.9k/42.3M [00:00&lt;03:53, 181kB/s]
-  0%|▏                                      | 188k/42.3M [00:00&lt;01:55, 364kB/s]
-  1%|▍                                      | 410k/42.3M [00:00&lt;00:57, 722kB/s]
-  2%|▊                                     | 851k/42.3M [00:00&lt;00:29, 1.40MB/s]
-  4%|█▌                                   | 1.73M/42.3M [00:01&lt;00:14, 2.72MB/s]
-  8%|███                                  | 3.48M/42.3M [00:01&lt;00:07, 5.29MB/s]
- 15%|█████▍                               | 6.28M/42.3M [00:01&lt;00:03, 9.03MB/s]
- 21%|███████▊                             | 8.94M/42.3M [00:01&lt;00:02, 11.3MB/s]
- 27%|█████████▊                           | 11.2M/42.3M [00:01&lt;00:02, 12.2MB/s]
- 33%|████████████                         | 13.8M/42.3M [00:01&lt;00:02, 13.3MB/s]
- 39%|██████████████▎                      | 16.4M/42.3M [00:02&lt;00:01, 14.1MB/s]
- 45%|████████████████▌                    | 18.9M/42.3M [00:02&lt;00:01, 14.5MB/s]
- 51%|██████████████████▋                  | 21.4M/42.3M [00:02&lt;00:01, 14.8MB/s]
- 57%|█████████████████████                | 24.0M/42.3M [00:02&lt;00:01, 15.2MB/s]
- 63%|███████████████████████▏             | 26.5M/42.3M [00:02&lt;00:01, 15.4MB/s]
- 69%|█████████████████████████▍           | 29.0M/42.3M [00:02&lt;00:00, 15.4MB/s]
- 75%|███████████████████████████▋         | 31.6M/42.3M [00:03&lt;00:00, 15.5MB/s]
- 81%|█████████████████████████████▉       | 34.2M/42.3M [00:03&lt;00:00, 15.6MB/s]
- 87%|████████████████████████████████▏    | 36.7M/42.3M [00:03&lt;00:00, 15.7MB/s]
- 93%|██████████████████████████████████▍  | 39.3M/42.3M [00:03&lt;00:00, 15.7MB/s]
- 99%|████████████████████████████████████▋| 41.9M/42.3M [00:03&lt;00:00, 15.8MB/s]
+  0%|                                      | 46.1k/42.3M [00:00&lt;02:06, 334kB/s]
+  0%|                                       | 114k/42.3M [00:00&lt;01:44, 405kB/s]
+  1%|▍                                     | 443k/42.3M [00:00&lt;00:32, 1.30MB/s]
+  3%|▉                                    | 1.06M/42.3M [00:00&lt;00:16, 2.47MB/s]
+  6%|██                                   | 2.39M/42.3M [00:00&lt;00:07, 5.50MB/s]
+ 12%|████▎                                | 4.94M/42.3M [00:00&lt;00:03, 11.2MB/s]
+ 19%|███████                              | 8.14M/42.3M [00:00&lt;00:01, 17.2MB/s]
+ 26%|█████████▍                           | 10.8M/42.3M [00:00&lt;00:01, 19.0MB/s]
+ 32%|███████████▉                         | 13.7M/42.3M [00:01&lt;00:01, 21.6MB/s]
+ 39%|██████████████▍                      | 16.5M/42.3M [00:01&lt;00:01, 23.5MB/s]
+ 46%|████████████████▉                    | 19.4M/42.3M [00:01&lt;00:00, 25.1MB/s]
+ 52%|███████████████████▎                 | 22.0M/42.3M [00:01&lt;00:00, 23.1MB/s]
+ 59%|█████████████████████▊               | 24.9M/42.3M [00:01&lt;00:00, 24.7MB/s]
+ 66%|████████████████████████▎            | 27.8M/42.3M [00:01&lt;00:00, 26.0MB/s]
+ 73%|██████████████████████████▉          | 30.8M/42.3M [00:01&lt;00:00, 27.1MB/s]
+ 80%|█████████████████████████████▊       | 34.0M/42.3M [00:01&lt;00:00, 28.6MB/s]
+ 87%|████████████████████████████████▎    | 36.9M/42.3M [00:01&lt;00:00, 27.3MB/s]
+ 95%|███████████████████████████████████  | 40.1M/42.3M [00:02&lt;00:00, 28.5MB/s]
   0%|                                              | 0.00/42.3M [00:00&lt;?, ?B/s]
-100%|██████████████████████████████████████| 42.3M/42.3M [00:00&lt;00:00, 270GB/s]
+100%|██████████████████████████████████████| 42.3M/42.3M [00:00&lt;00:00, 185GB/s]
 </pre></div>
 </div>
 <div class="line-block">
@@ -517,7 +498,7 @@
 <a href="https://hyperspy.org/hyperspy-doc/dev/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 10.844 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 8.344 seconds)</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-model-fitting-eels-curve-fitting-py">
 <div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
 <p><a class="reference download internal" download="" href="../../_downloads/037b5aa4752b41748abf69bba9d1cbe4/EELS_curve_fitting.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">EELS_curve_fitting.ipynb</span></code></a></p>

diff --git a/auto_examples/model_fitting/index.html b/auto_examples/model_fitting/index.html
@@ -172,13 +172,6 @@
                     </li>
 
 
-                    <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../citing.html">
-                        Citing
-                      </a>
-                    </li>
-
-
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../contributing.html">
                         Contribute
@@ -323,13 +316,6 @@
                     </li>
 
 
-                    <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../citing.html">
-                        Citing
-                      </a>
-                    </li>
-
-
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../contributing.html">
                         Contribute