Update docs build

hyperspy · Dec 2, 2023 · 6412159 · 6412159
1 parent c677b87
commit 6412159
Show file tree

Hide file tree

Showing 47 changed files with 2,132 additions and 541 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: 59dbbd02b04ea9ed39ef43f51da15293
+config: 4ca2f809cc2775ad11cb4e5b110f0357
 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%|                                      | 36.9k/42.3M [00:00<03:30, 201kB/s]      0%|                                       | 119k/42.3M [00:00<02:02, 344kB/s]      1%|▎                                      | 359k/42.3M [00:00<00:54, 764kB/s]      3%|█▏                                   | 1.31M/42.3M [00:00<00:13, 3.00MB/s]      6%|██▎                                  | 2.69M/42.3M [00:00<00:06, 5.90MB/s]     11%|████                                 | 4.71M/42.3M [00:00<00:03, 9.87MB/s]     17%|██████▏                              | 7.07M/42.3M [00:01<00:03, 11.7MB/s]     23%|████████▌                            | 9.81M/42.3M [00:01<00:02, 15.7MB/s]     29%|██████████▊                          | 12.4M/42.3M [00:01<00:01, 18.5MB/s]     36%|█████████████▎                       | 15.2M/42.3M [00:01<00:01, 21.0MB/s]     41%|███████████████▎                     | 17.4M/42.3M [00:01<00:01, 18.3MB/s]     48%|█████████████████▌                   | 20.1M/42.3M [00:01<00:01, 20.4MB/s]     54%|███████████████████▉                 | 22.8M/42.3M [00:01<00:00, 22.3MB/s]     60%|██████████████████████               | 25.2M/42.3M [00:01<00:00, 22.5MB/s]     66%|████████████████████████▎            | 27.8M/42.3M [00:01<00:00, 19.8MB/s]     72%|██████████████████████████▋          | 30.5M/42.3M [00:02<00:00, 21.5MB/s]     78%|████████████████████████████▉        | 33.1M/42.3M [00:02<00:00, 22.8MB/s]     85%|███████████████████████████████▍     | 35.9M/42.3M [00:02<00:00, 24.1MB/s]     91%|█████████████████████████████████▌   | 38.4M/42.3M [00:02<00:00, 20.5MB/s]     97%|███████████████████████████████████▉ | 41.1M/42.3M [00:02<00:00, 22.2MB/s]      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]    100%|██████████████████████████████████████| 42.3M/42.3M [00:00<00:00, 299GB/s]
+      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]      0%|                                      | 48.1k/42.3M [00:00<02:48, 251kB/s]      0%|▏                                      | 199k/42.3M [00:00<01:14, 564kB/s]      2%|▋                                     | 710k/42.3M [00:00<00:21, 1.95MB/s]      4%|█▎                                   | 1.48M/42.3M [00:00<00:11, 3.70MB/s]      6%|██▎                                  | 2.70M/42.3M [00:00<00:06, 6.27MB/s]     11%|████▏                                | 4.72M/42.3M [00:00<00:03, 10.4MB/s]     18%|██████▋                              | 7.70M/42.3M [00:00<00:02, 15.2MB/s]     25%|█████████▍                           | 10.7M/42.3M [00:01<00:01, 19.6MB/s]     33%|████████████                         | 13.8M/42.3M [00:01<00:01, 22.7MB/s]     39%|██████████████▍                      | 16.5M/42.3M [00:01<00:01, 24.1MB/s]     46%|████████████████▉                    | 19.4M/42.3M [00:01<00:01, 22.7MB/s]     53%|███████████████████▍                 | 22.2M/42.3M [00:01<00:00, 24.3MB/s]     60%|██████████████████████               | 25.2M/42.3M [00:01<00:00, 25.8MB/s]     66%|████████████████████████▌            | 28.1M/42.3M [00:01<00:00, 26.8MB/s]     73%|███████████████████████████▏         | 31.0M/42.3M [00:01<00:00, 27.6MB/s]     81%|█████████████████████████████▊       | 34.1M/42.3M [00:01<00:00, 28.4MB/s]     87%|████████████████████████████████▎    | 36.9M/42.3M [00:01<00:00, 26.9MB/s]     94%|██████████████████████████████████▉  | 39.9M/42.3M [00:02<00:00, 27.8MB/s]      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]    100%|██████████████████████████████████████| 42.3M/42.3M [00:00<00:00, 270GB/s]
 
 
 
@@ -47,7 +47,7 @@ png file.
 
 |
 
-.. code-block:: default
+.. code-block:: Python
 
 
     import hyperspy.api as hs
@@ -68,7 +68,7 @@ png file.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 8.862 seconds)
+   **Total running time of the script:** (0 minutes 8.179 seconds)
 
 
 .. _sphx_glr_download_auto_examples_model_fitting_EELS_curve_fitting.py:
@@ -77,17 +77,14 @@ png file.
 
   .. container:: sphx-glr-footer sphx-glr-footer-example
 
+    .. container:: sphx-glr-download sphx-glr-download-jupyter
 
-
+      :download:`Download Jupyter notebook: EELS_curve_fitting.ipynb <EELS_curve_fitting.ipynb>`
 
     .. container:: sphx-glr-download sphx-glr-download-python
 
       :download:`Download Python source code: EELS_curve_fitting.py <EELS_curve_fitting.py>`
 
-    .. container:: sphx-glr-download sphx-glr-download-jupyter
-
-      :download:`Download Jupyter notebook: EELS_curve_fitting.ipynb <EELS_curve_fitting.ipynb>`
-
 
 .. only:: html
 

diff --git a/_sources/auto_examples/model_fitting/plot_residual.rst.txt b/_sources/auto_examples/model_fitting/plot_residual.rst.txt
@@ -25,7 +25,7 @@ Fit an affine function and plot the residual.
 
 .. GENERATED FROM PYTHON SOURCE LINES 8-12
 
-.. code-block:: default
+.. code-block:: Python
 
 
     import numpy as np
@@ -44,7 +44,7 @@ Create a signal:
 
 .. GENERATED FROM PYTHON SOURCE LINES 14-17
 
-.. code-block:: default
+.. code-block:: Python
 
     data = np.arange(1000, dtype=np.int64).reshape((10, 100))
     s = hs.signals.Signal1D(data)
@@ -62,7 +62,7 @@ Add noise:
 
 .. GENERATED FROM PYTHON SOURCE LINES 19-21
 
-.. code-block:: default
+.. code-block:: Python
 
     s.add_poissonian_noise(random_state=0)
 
@@ -79,7 +79,7 @@ Create model:
 
 .. GENERATED FROM PYTHON SOURCE LINES 23-27
 
-.. code-block:: default
+.. code-block:: Python
 
     m = s.create_model()
     line = hs.model.components1D.Expression("a * x + b", name="Affine")
@@ -98,7 +98,7 @@ Fit for all navigation positions:
 
 .. GENERATED FROM PYTHON SOURCE LINES 29-31
 
-.. code-block:: default
+.. code-block:: Python
 
     m.multifit()
 
@@ -110,15 +110,15 @@ Fit for all navigation positions:
 
  .. code-block:: none
 
-    Exception ignored in: <function tqdm.__del__ at 0x7f7aed851ee0>
+    Exception ignored in: <function tqdm.__del__ at 0x7f2154478900>
     Traceback (most recent call last):
       File "/opt/hostedtoolcache/Python/3.11.6/x64/lib/python3.11/site-packages/tqdm/std.py", line 1149, in __del__
         self.close()
       File "/opt/hostedtoolcache/Python/3.11.6/x64/lib/python3.11/site-packages/tqdm/notebook.py", line 278, 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, 1470.76it/s]
+      0%|          | 0/10 [00:00<?, ?it/s]    100%|██████████| 10/10 [00:00<00:00, 1453.18it/s]
 
 
 
@@ -129,7 +129,7 @@ Plot the fitted model with residual:
 
 .. GENERATED FROM PYTHON SOURCE LINES 33-35
 
-.. code-block:: default
+.. code-block:: Python
 
     m.plot(plot_residual=True)
 
@@ -164,7 +164,7 @@ sphinx_gallery_thumbnail_number = 2
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.571 seconds)
+   **Total running time of the script:** (0 minutes 0.516 seconds)
 
 
 .. _sphx_glr_download_auto_examples_model_fitting_plot_residual.py:
@@ -173,17 +173,14 @@ sphinx_gallery_thumbnail_number = 2
 
   .. container:: sphx-glr-footer sphx-glr-footer-example
 
+    .. container:: sphx-glr-download sphx-glr-download-jupyter
 
-
+      :download:`Download Jupyter notebook: plot_residual.ipynb <plot_residual.ipynb>`
 
     .. container:: sphx-glr-download sphx-glr-download-python
 
       :download:`Download Python source code: plot_residual.py <plot_residual.py>`
 
-    .. container:: sphx-glr-download sphx-glr-download-jupyter
-
-      :download:`Download Jupyter notebook: plot_residual.ipynb <plot_residual.ipynb>`
-
 
 .. only:: html
 

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,12 +6,38 @@
 
 Computation times
 =================
-**00:09.746** total execution time for **auto_examples_model_fitting** files:
-
-+-----------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_model_fitting_EELS_curve_fitting.py` (``EELS_curve_fitting.py``) | 00:08.862 | 0.0 MB |
-+-----------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``plot_residual.py``)           | 00:00.571 | 0.0 MB |
-+-----------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py` (``simple_arctan_fit.py``)   | 00:00.312 | 0.0 MB |
-+-----------------------------------------------------------------------------------------------+-----------+--------+
+**00:09.061** total execution time for 3 files **from auto_examples/model_fitting**:
+
+.. container::
+
+  .. raw:: html
+
+    <style scoped>
+    <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
+    <link href="https://cdn.datatables.net/1.13.6/css/dataTables.bootstrap5.min.css" rel="stylesheet" />
+    </style>
+    <script src="https://code.jquery.com/jquery-3.7.0.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/jquery.dataTables.min.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/dataTables.bootstrap5.min.js"></script>
+    <script type="text/javascript" class="init">
+    $(document).ready( function () {
+        $('table.sg-datatable').DataTable({order: [[1, 'desc']]});
+    } );
+    </script>
+
+  .. list-table::
+   :header-rows: 1
+   :class: table table-striped sg-datatable
+
+   * - Example
+     - Time
+     - Mem (MB)
+   * - :ref:`sphx_glr_auto_examples_model_fitting_EELS_curve_fitting.py` (``EELS_curve_fitting.py``)
+     - 00:08.179
+     - 0.0
+   * - :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``plot_residual.py``)
+     - 00:00.516
+     - 0.0
+   * - :ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py` (``simple_arctan_fit.py``)
+     - 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.99914977 | 0.00212004 |       None |       None |   True
-                 k |    True | 0.95883549 | 0.07856293 |       None |       None |  False
-                x0 |    True | -0.2038163 | 0.08135391 |       None |       None |  False
+                 A |    True | 1.00220217 | 0.00212701 |       None |       None |   True
+                 k |    True | 1.09957149 | 0.09786674 |       None |       None |  False
+                x0 |    True | -0.0289328 | 0.07487562 |       None |       None |  False
 
 
 
@@ -55,7 +55,7 @@ Fit an arctan function.
 
 |
 
-.. code-block:: default
+.. code-block:: Python
 
 
     import numpy as np
@@ -91,7 +91,7 @@ Fit an arctan function.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.312 seconds)
+   **Total running time of the script:** (0 minutes 0.366 seconds)
 
 
 .. _sphx_glr_download_auto_examples_model_fitting_simple_arctan_fit.py:
@@ -100,17 +100,14 @@ Fit an arctan function.
 
   .. container:: sphx-glr-footer sphx-glr-footer-example
 
+    .. container:: sphx-glr-download sphx-glr-download-jupyter
 
-
+      :download:`Download Jupyter notebook: simple_arctan_fit.ipynb <simple_arctan_fit.ipynb>`
 
     .. container:: sphx-glr-download sphx-glr-download-python
 
       :download:`Download Python source code: simple_arctan_fit.py <simple_arctan_fit.py>`
 
-    .. container:: sphx-glr-download sphx-glr-download-jupyter
-
-      :download:`Download Jupyter notebook: simple_arctan_fit.ipynb <simple_arctan_fit.ipynb>`
-
 
 .. only:: html
 

diff --git a/_sources/auto_examples/sg_execution_times.rst.txt b/_sources/auto_examples/sg_execution_times.rst.txt
@@ -0,0 +1,37 @@
+
+:orphan:
+
+.. _sphx_glr_auto_examples_sg_execution_times:
+
+
+Computation times
+=================
+**00:00.000** total execution time for 0 files **from auto_examples**:
+
+.. container::
+
+  .. raw:: html
+
+    <style scoped>
+    <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
+    <link href="https://cdn.datatables.net/1.13.6/css/dataTables.bootstrap5.min.css" rel="stylesheet" />
+    </style>
+    <script src="https://code.jquery.com/jquery-3.7.0.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/jquery.dataTables.min.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/dataTables.bootstrap5.min.js"></script>
+    <script type="text/javascript" class="init">
+    $(document).ready( function () {
+        $('table.sg-datatable').DataTable({order: [[1, 'desc']]});
+    } );
+    </script>
+
+  .. list-table::
+   :header-rows: 1
+   :class: table table-striped sg-datatable
+
+   * - Example
+     - Time
+     - Mem (MB)
+   * - N/A
+     - N/A
+     - N/A
diff --git a/_sources/sg_execution_times.rst.txt b/_sources/sg_execution_times.rst.txt
@@ -0,0 +1,43 @@
+
+:orphan:
+
+.. _sphx_glr_sg_execution_times:
+
+
+Computation times
+=================
+**00:09.061** total execution time for 3 files **from all galleries**:
+
+.. container::
+
+  .. raw:: html
+
+    <style scoped>
+    <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
+    <link href="https://cdn.datatables.net/1.13.6/css/dataTables.bootstrap5.min.css" rel="stylesheet" />
+    </style>
+    <script src="https://code.jquery.com/jquery-3.7.0.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/jquery.dataTables.min.js"></script>
+    <script src="https://cdn.datatables.net/1.13.6/js/dataTables.bootstrap5.min.js"></script>
+    <script type="text/javascript" class="init">
+    $(document).ready( function () {
+        $('table.sg-datatable').DataTable({order: [[1, 'desc']]});
+    } );
+    </script>
+
+  .. list-table::
+   :header-rows: 1
+   :class: table table-striped sg-datatable
+
+   * - Example
+     - Time
+     - Mem (MB)
+   * - :ref:`sphx_glr_auto_examples_model_fitting_EELS_curve_fitting.py` (``../examples/model_fitting/EELS_curve_fitting.py``)
+     - 00:08.179
+     - 0.0
+   * - :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``../examples/model_fitting/plot_residual.py``)
+     - 00:00.516
+     - 0.0
+   * - :ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py` (``../examples/model_fitting/simple_arctan_fit.py``)
+     - 00:00.366
+     - 0.0