Update docs build

hyperspy · Sep 16, 2024 · f0351ec · f0351ec
1 parent 08cbd2b
commit f0351ec
Show file tree

Hide file tree

Showing 24 changed files with 229 additions and 149 deletions.
diff --git a/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/_downloads/24831b32e81d1315cd64203e4e17d1bf/simple_arctan_fit.zip b/_downloads/24831b32e81d1315cd64203e4e17d1bf/simple_arctan_fit.zip
diff --git a/_downloads/3b9b969a6a4343ec82db54cb1db2df83/EELS_curve_fitting.zip b/_downloads/3b9b969a6a4343ec82db54cb1db2df83/EELS_curve_fitting.zip
diff --git a/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/_downloads/90f956a0ec1a60c2f96c8c92607d6fea/plot_residual.zip b/_downloads/90f956a0ec1a60c2f96c8c92607d6fea/plot_residual.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,8 +38,8 @@ png file.
 
  .. code-block:: none
 
-      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]      0%|                                      | 18.4k/42.3M [00:00<04:20, 162kB/s]      0%|                                      | 54.3k/42.3M [00:00<02:46, 254kB/s]      0%|                                       | 135k/42.3M [00:00<01:30, 466kB/s]      1%|▎                                      | 287k/42.3M [00:00<00:51, 813kB/s]      1%|▌                                     | 601k/42.3M [00:00<00:27, 1.53MB/s]      3%|█                                    | 1.24M/42.3M [00:00<00:13, 2.94MB/s]      6%|██▏                                  | 2.51M/42.3M [00:00<00:06, 5.68MB/s]     12%|████▍                                | 5.07M/42.3M [00:00<00:03, 11.1MB/s]     19%|███████▏                             | 8.16M/42.3M [00:01<00:02, 16.2MB/s]     26%|█████████▋                           | 11.0M/42.3M [00:01<00:01, 19.1MB/s]     32%|███████████▉                         | 13.6M/42.3M [00:01<00:01, 20.3MB/s]     38%|██████████████▏                      | 16.2M/42.3M [00:01<00:01, 21.1MB/s]     45%|████████████████▌                    | 18.9M/42.3M [00:01<00:01, 21.9MB/s]     51%|██████████████████▉                  | 21.6M/42.3M [00:01<00:00, 22.8MB/s]     58%|█████████████████████▍               | 24.5M/42.3M [00:01<00:00, 23.4MB/s]     64%|███████████████████████▋             | 27.1M/42.3M [00:01<00:00, 23.4MB/s]     70%|██████████████████████████           | 29.7M/42.3M [00:01<00:00, 23.5MB/s]     77%|████████████████████████████▍        | 32.5M/42.3M [00:02<00:00, 23.8MB/s]     84%|██████████████████████████████▉      | 35.3M/42.3M [00:02<00:00, 24.2MB/s]     90%|█████████████████████████████████▎   | 38.0M/42.3M [00:02<00:00, 24.2MB/s]     96%|███████████████████████████████████▌ | 40.7M/42.3M [00:02<00:00, 24.0MB/s]      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]    100%|██████████████████████████████████████| 42.3M/42.3M [00:00<00:00, 281GB/s]
-      0%|                                              | 0.00/66.1M [00:00<?, ?B/s]      0%|                                      | 18.4k/66.1M [00:00<06:49, 161kB/s]      0%|                                      | 50.2k/66.1M [00:00<04:47, 230kB/s]      0%|                                       | 135k/66.1M [00:00<02:23, 459kB/s]      0%|▏                                      | 293k/66.1M [00:00<01:19, 824kB/s]      1%|▎                                     | 602k/66.1M [00:00<00:43, 1.51MB/s]      2%|▋                                    | 1.24M/66.1M [00:00<00:22, 2.90MB/s]      4%|█▍                                   | 2.53M/66.1M [00:00<00:11, 5.67MB/s]      8%|██▊                                  | 5.08M/66.1M [00:00<00:05, 11.0MB/s]     12%|████▎                                | 7.76M/66.1M [00:01<00:03, 15.0MB/s]     15%|█████▋                               | 10.1M/66.1M [00:01<00:03, 16.8MB/s]     19%|███████                              | 12.5M/66.1M [00:01<00:02, 18.1MB/s]     23%|████████▍                            | 15.1M/66.1M [00:01<00:02, 19.5MB/s]     27%|█████████▊                           | 17.6M/66.1M [00:01<00:02, 20.3MB/s]     30%|███████████▏                         | 20.0M/66.1M [00:01<00:02, 20.6MB/s]     34%|████████████▌                        | 22.4M/66.1M [00:01<00:02, 20.9MB/s]     38%|█████████████▉                       | 24.9M/66.1M [00:01<00:01, 21.3MB/s]     41%|███████████████▎                     | 27.4M/66.1M [00:01<00:01, 21.4MB/s]     45%|████████████████▋                    | 29.8M/66.1M [00:02<00:01, 21.4MB/s]     49%|██████████████████▏                  | 32.4M/66.1M [00:02<00:01, 21.8MB/s]     53%|███████████████████▌                 | 34.9M/66.1M [00:02<00:01, 21.7MB/s]     57%|████████████████████▉                | 37.4M/66.1M [00:02<00:01, 21.8MB/s]     60%|██████████████████████▎              | 39.9M/66.1M [00:02<00:01, 21.9MB/s]     64%|███████████████████████▋             | 42.4M/66.1M [00:02<00:01, 21.9MB/s]     68%|█████████████████████████            | 44.8M/66.1M [00:02<00:00, 21.7MB/s]     72%|██████████████████████████▍          | 47.3M/66.1M [00:02<00:00, 21.9MB/s]     75%|███████████████████████████▉         | 49.8M/66.1M [00:02<00:00, 22.0MB/s]     79%|█████████████████████████████▎       | 52.3M/66.1M [00:03<00:00, 21.9MB/s]     83%|██████████████████████████████▋      | 54.8M/66.1M [00:03<00:00, 22.0MB/s]     87%|████████████████████████████████     | 57.3M/66.1M [00:03<00:00, 22.1MB/s]     91%|█████████████████████████████████▍   | 59.8M/66.1M [00:03<00:00, 22.1MB/s]     94%|██████████████████████████████████▉  | 62.4M/66.1M [00:03<00:00, 22.1MB/s]     98%|████████████████████████████████████▎| 64.9M/66.1M [00:03<00:00, 22.2MB/s]      0%|                                              | 0.00/66.1M [00:00<?, ?B/s]    100%|██████████████████████████████████████| 66.1M/66.1M [00:00<00:00, 441GB/s]
+      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]      0%|                                      | 14.3k/42.3M [00:00<06:47, 104kB/s]      0%|                                      | 53.2k/42.3M [00:00<02:51, 247kB/s]      1%|▏                                      | 248k/42.3M [00:00<01:00, 699kB/s]      1%|▌                                     | 558k/42.3M [00:00<00:29, 1.42MB/s]      3%|█▏                                   | 1.35M/42.3M [00:00<00:12, 3.40MB/s]      7%|██▍                                  | 2.79M/42.3M [00:00<00:05, 6.70MB/s]     12%|████▌                                | 5.28M/42.3M [00:00<00:03, 12.2MB/s]     18%|██████▌                              | 7.51M/42.3M [00:00<00:02, 15.2MB/s]     24%|████████▋                            | 9.99M/42.3M [00:01<00:01, 18.1MB/s]     29%|██████████▊                          | 12.3M/42.3M [00:01<00:01, 19.6MB/s]     35%|████████████▉                        | 14.8M/42.3M [00:01<00:01, 21.1MB/s]     40%|██████████████▉                      | 17.0M/42.3M [00:01<00:01, 17.9MB/s]     46%|████████████████▉                    | 19.4M/42.3M [00:01<00:01, 19.5MB/s]     52%|███████████████████                  | 21.8M/42.3M [00:01<00:00, 20.8MB/s]     57%|█████████████████████▏               | 24.3M/42.3M [00:01<00:00, 21.8MB/s]     63%|███████████████████████▍             | 26.8M/42.3M [00:01<00:00, 22.7MB/s]     69%|█████████████████████████▌           | 29.3M/42.3M [00:01<00:00, 23.4MB/s]     75%|███████████████████████████▊         | 31.8M/42.3M [00:01<00:00, 24.1MB/s]     81%|█████████████████████████████▉       | 34.3M/42.3M [00:02<00:00, 24.2MB/s]     87%|████████████████████████████████▏    | 36.8M/42.3M [00:02<00:00, 24.6MB/s]     93%|██████████████████████████████████▍  | 39.3M/42.3M [00:02<00:00, 20.5MB/s]     99%|████████████████████████████████████▍| 41.7M/42.3M [00:02<00:00, 21.3MB/s]      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]    100%|██████████████████████████████████████| 42.3M/42.3M [00:00<00:00, 253GB/s]
+      0%|                                              | 0.00/66.1M [00:00<?, ?B/s]      0%|                                     | 12.3k/66.1M [00:00<11:11, 98.4kB/s]      0%|                                      | 88.1k/66.1M [00:00<03:39, 301kB/s]      1%|▏                                      | 385k/66.1M [00:00<01:11, 915kB/s]      2%|▌                                    | 1.07M/66.1M [00:00<00:25, 2.52MB/s]      3%|█▏                                   | 2.12M/66.1M [00:00<00:13, 4.73MB/s]      6%|██▏                                  | 3.93M/66.1M [00:00<00:07, 8.53MB/s]     11%|████▏                                | 7.48M/66.1M [00:00<00:03, 15.0MB/s]     16%|█████▉                               | 10.5M/66.1M [00:01<00:02, 19.3MB/s]     21%|███████▌                             | 13.6M/66.1M [00:01<00:02, 22.5MB/s]     25%|█████████                            | 16.3M/66.1M [00:01<00:02, 23.7MB/s]     29%|██████████▋                          | 19.2M/66.1M [00:01<00:01, 25.2MB/s]     33%|████████████▏                        | 21.8M/66.1M [00:01<00:01, 23.1MB/s]     37%|█████████████▊                       | 24.6M/66.1M [00:01<00:01, 24.7MB/s]     42%|███████████████▍                     | 27.5M/66.1M [00:01<00:01, 25.8MB/s]     46%|████████████████▉                    | 30.3M/66.1M [00:01<00:01, 26.5MB/s]     50%|██████████████████▌                  | 33.2M/66.1M [00:01<00:01, 27.1MB/s]     54%|████████████████████                 | 35.9M/66.1M [00:02<00:01, 25.2MB/s]     59%|█████████████████████▋               | 38.8M/66.1M [00:02<00:01, 26.2MB/s]     63%|███████████████████████▎             | 41.6M/66.1M [00:02<00:00, 26.6MB/s]     68%|█████████████████████████            | 44.7M/66.1M [00:02<00:00, 27.9MB/s]     72%|██████████████████████████▌          | 47.6M/66.1M [00:02<00:00, 25.3MB/s]     77%|████████████████████████████▍        | 50.7M/66.1M [00:02<00:00, 27.0MB/s]     81%|██████████████████████████████▏      | 53.8M/66.1M [00:02<00:00, 28.2MB/s]     86%|███████████████████████████████▊     | 56.8M/66.1M [00:02<00:00, 28.6MB/s]     90%|█████████████████████████████████▍   | 59.8M/66.1M [00:02<00:00, 28.7MB/s]     95%|███████████████████████████████████  | 62.7M/66.1M [00:02<00:00, 29.0MB/s]    100%|████████████████████████████████████▉| 65.9M/66.1M [00:03<00:00, 29.8MB/s]      0%|                                              | 0.00/66.1M [00:00<?, ?B/s]    100%|██████████████████████████████████████| 66.1M/66.1M [00:00<00:00, 435GB/s]
 
 
 
@@ -76,7 +76,7 @@ png file.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 17.739 seconds)
+   **Total running time of the script:** (0 minutes 16.891 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 0x7fba1eeaac00>
+    Exception ignored in: <function tqdm.__del__ at 0x7f87009ff240>
     Traceback (most recent call last):
       File "/opt/hostedtoolcache/Python/3.11.9/x64/lib/python3.11/site-packages/tqdm/std.py", line 1148, in __del__
         self.close()
       File "/opt/hostedtoolcache/Python/3.11.9/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, 1508.36it/s]
+      0%|          | 0/10 [00:00<?, ?it/s]    100%|██████████| 10/10 [00:00<00:00, 1477.08it/s]
 
 
 
@@ -164,7 +164,7 @@ sphinx_gallery_thumbnail_number = 2
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.453 seconds)
+   **Total running time of the script:** (0 minutes 0.477 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:18.519** total execution time for 3 files **from auto_examples/model_fitting**:
+**00:17.693** 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:17.739
+     - 00:16.891
      - 0.0
    * - :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``plot_residual.py``)
-     - 00:00.453
+     - 00:00.477
      - 0.0
    * - :ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py` (``simple_arctan_fit.py``)
-     - 00:00.327
+     - 00:00.325
      - 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.99889535 | 0.00203467 |       None |       None |   True
-                 k |    True | 1.13231747 | 0.09842399 |       None |       None |  False
-                x0 |    True | -0.0071833 | 0.07061723 |       None |       None |  False
+                 A |    True | 0.99660893 | 0.00206940 |       None |       None |   True
+                 k |    True | 0.98227444 | 0.08025824 |       None |       None |  False
+                x0 |    True | 0.03142528 | 0.07797092 |       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.327 seconds)
+   **Total running time of the script:** (0 minutes 0.325 seconds)
 
 
 .. _sphx_glr_download_auto_examples_model_fitting_simple_arctan_fit.py:

diff --git a/_sources/sg_execution_times.rst.txt b/_sources/sg_execution_times.rst.txt
@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:18.519** total execution time for 3 files **from all galleries**:
+**00:17.693** 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:17.739
+     - 00:16.891
      - 0.0
    * - :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``../examples/model_fitting/plot_residual.py``)
-     - 00:00.453
+     - 00:00.477
      - 0.0
    * - :ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py` (``../examples/model_fitting/simple_arctan_fit.py``)
-     - 00:00.327
+     - 00:00.325
      - 0.0
diff --git a/_sources/user_guide/eels.rst.txt b/_sources/user_guide/eels.rst.txt
@@ -394,16 +394,17 @@ edge functionalities:
 
 .. _eels.fine_structure:
 
-Fine structure analysis
-^^^^^^^^^^^^^^^^^^^^^^^
+Fine structure analysis using a spline function
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The fine structure of an EELS ionization edge manifests as distinct features within
 the first few tens of eVs energy. It is due to variations in the electron's energy
 loss probability caused by the interactions with the material's electronic structure.
 It offers insights into the material's electronic properties, bonding, and local environments.
 Therefore, we cannot model them from first-principles because i) the material is usually unknown
-ii) HyperSpy only supports Hydrogenic and Hartree-Slater EELS core-loss models. Instead, the
-:py:class:`~.components.EELSCLEdge` component includes features
+ii) HyperSpy supports Hydrogenic, Hartree-Slater EELS, DFT and Dirac core-loss models, which don't
+include modeling of the fine structure - see :ref:`eels.GOS` and :class:`~.components.EELSCLEdge`
+for more information. Instead, the :py:class:`~.components.EELSCLEdge` component includes features
 for EELS fine structure modelling and analysis using functions to mimic the fine structure
 features. The most basic consists in modelling
 the fine structure of ionization edges using a spline function. You can activate this feature
@@ -483,8 +484,8 @@ structure width. It is possible to suspend this feature by calling
 To resume it use
 :py:meth:`~.models.EELSModel.suspend_auto_fine_structure_width`
 
-Fine structure analysis
-"""""""""""""""""""""""
+Fine structure analysis using Gaussian functions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Fine structure analysis consists on measuring different features of the fine structure
 (e.g., peak position, area, ...). Often, these features can be related to the ionized atom environment.