Update docs build

hyperspy · Sep 18, 2024 · 36de996 · 36de996
1 parent f0351ec
commit 36de996
Show file tree

Hide file tree

Showing 23 changed files with 223 additions and 173 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%|                                      | 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]
+      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]      0%|                                      | 16.4k/42.3M [00:00<04:53, 144kB/s]      0%|                                      | 39.9k/42.3M [00:00<03:47, 186kB/s]      0%|                                       | 121k/42.3M [00:00<01:37, 432kB/s]      1%|▏                                      | 266k/42.3M [00:00<00:54, 775kB/s]      1%|▌                                     | 560k/42.3M [00:00<00:28, 1.44MB/s]      3%|█                                    | 1.17M/42.3M [00:00<00:14, 2.78MB/s]      6%|██                                   | 2.34M/42.3M [00:00<00:07, 5.30MB/s]     11%|████                                 | 4.71M/42.3M [00:00<00:03, 10.4MB/s]     18%|██████▊                              | 7.72M/42.3M [00:01<00:02, 15.5MB/s]     24%|████████▉                            | 10.2M/42.3M [00:01<00:01, 16.3MB/s]     28%|██████████▎                          | 11.8M/42.3M [00:01<00:02, 14.7MB/s]     34%|████████████▌                        | 14.3M/42.3M [00:01<00:01, 17.1MB/s]     40%|██████████████▊                      | 16.9M/42.3M [00:01<00:01, 18.8MB/s]     46%|████████████████▉                    | 19.3M/42.3M [00:01<00:01, 19.7MB/s]     52%|███████████████████                  | 21.8M/42.3M [00:01<00:01, 20.4MB/s]     58%|█████████████████████▎               | 24.3M/42.3M [00:01<00:00, 21.1MB/s]     64%|███████████████████████▌             | 26.9M/42.3M [00:01<00:00, 21.7MB/s]     70%|█████████████████████████▋           | 29.4M/42.3M [00:02<00:00, 21.9MB/s]     76%|████████████████████████████         | 32.0M/42.3M [00:02<00:00, 22.2MB/s]     82%|██████████████████████████████▎      | 34.6M/42.3M [00:02<00:00, 22.6MB/s]     88%|████████████████████████████████▋    | 37.4M/42.3M [00:02<00:00, 23.1MB/s]     95%|██████████████████████████████████▉  | 40.0M/42.3M [00:02<00:00, 22.8MB/s]      0%|                                              | 0.00/42.3M [00:00<?, ?B/s]    100%|██████████████████████████████████████| 42.3M/42.3M [00:00<00:00, 185GB/s]
+      0%|                                              | 0.00/66.1M [00:00<?, ?B/s]      0%|                                      | 16.4k/66.1M [00:00<07:28, 147kB/s]      0%|                                      | 48.1k/66.1M [00:00<04:50, 227kB/s]      0%|                                       | 126k/66.1M [00:00<02:29, 440kB/s]      0%|▏                                      | 265k/66.1M [00:00<01:27, 756kB/s]      1%|▎                                     | 570k/66.1M [00:00<00:44, 1.46MB/s]      2%|▋                                    | 1.16M/66.1M [00:00<00:23, 2.75MB/s]      4%|█▎                                   | 2.34M/66.1M [00:00<00:12, 5.27MB/s]      7%|██▋                                  | 4.72M/66.1M [00:00<00:05, 10.4MB/s]     10%|███▋                                 | 6.70M/66.1M [00:01<00:04, 12.6MB/s]     14%|█████                                | 8.95M/66.1M [00:01<00:03, 14.9MB/s]     17%|██████▏                              | 11.0M/66.1M [00:01<00:03, 16.0MB/s]     20%|███████▍                             | 13.3M/66.1M [00:01<00:03, 17.2MB/s]     23%|████████▋                            | 15.4M/66.1M [00:01<00:02, 17.8MB/s]     27%|█████████▊                           | 17.6M/66.1M [00:01<00:02, 18.1MB/s]     30%|███████████                          | 19.8M/66.1M [00:01<00:02, 18.6MB/s]     33%|████████████▏                        | 21.8M/66.1M [00:01<00:02, 17.9MB/s]     36%|█████████████▍                       | 23.9M/66.1M [00:01<00:02, 18.3MB/s]     39%|██████████████▍                      | 25.9M/66.1M [00:02<00:02, 18.0MB/s]     42%|███████████████▋                     | 28.1M/66.1M [00:02<00:02, 18.5MB/s]     46%|████████████████▊                    | 30.1M/66.1M [00:02<00:01, 18.3MB/s]     49%|██████████████████                   | 32.3M/66.1M [00:02<00:01, 18.6MB/s]     52%|███████████████████▎                 | 34.4M/66.1M [00:02<00:01, 18.8MB/s]     55%|████████████████████▍                | 36.6M/66.1M [00:02<00:01, 19.0MB/s]     59%|█████████████████████▋               | 38.8M/66.1M [00:02<00:01, 19.3MB/s]     62%|██████████████████████▉              | 41.0M/66.1M [00:02<00:01, 19.4MB/s]     66%|████████████████████████▏            | 43.3M/66.1M [00:02<00:01, 19.6MB/s]     69%|█████████████████████████▍           | 45.5M/66.1M [00:03<00:01, 19.6MB/s]     72%|██████████████████████████▊          | 47.8M/66.1M [00:03<00:00, 19.9MB/s]     76%|███████████████████████████▉         | 50.0M/66.1M [00:03<00:00, 19.8MB/s]     79%|█████████████████████████████▎       | 52.3M/66.1M [00:03<00:00, 19.9MB/s]     83%|██████████████████████████████▌      | 54.5M/66.1M [00:03<00:00, 20.0MB/s]     86%|███████████████████████████████▊     | 56.8M/66.1M [00:03<00:00, 20.0MB/s]     89%|█████████████████████████████████    | 59.1M/66.1M [00:03<00:00, 19.8MB/s]     93%|██████████████████████████████████▎  | 61.3M/66.1M [00:03<00:00, 20.0MB/s]     96%|███████████████████████████████████▍ | 63.4M/66.1M [00:03<00:00, 19.4MB/s]     99%|████████████████████████████████████▋| 65.6M/66.1M [00:04<00:00, 19.6MB/s]      0%|                                              | 0.00/66.1M [00:00<?, ?B/s]    100%|██████████████████████████████████████| 66.1M/66.1M [00:00<00:00, 353GB/s]
 
 
 
@@ -76,7 +76,7 @@ png file.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 16.891 seconds)
+   **Total running time of the script:** (0 minutes 18.439 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 0x7f87009ff240>
+    Exception ignored in: <function tqdm.__del__ at 0x7fe9b02a71a0>
     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, 1477.08it/s]
+      0%|          | 0/10 [00:00<?, ?it/s]    100%|██████████| 10/10 [00:00<00:00, 1467.26it/s]
 
 
 
@@ -164,7 +164,7 @@ sphinx_gallery_thumbnail_number = 2
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.477 seconds)
+   **Total running time of the script:** (0 minutes 0.472 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:17.693** total execution time for 3 files **from auto_examples/model_fitting**:
+**00:19.244** 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:16.891
+     - 00:18.439
      - 0.0
    * - :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``plot_residual.py``)
-     - 00:00.477
+     - 00:00.472
      - 0.0
    * - :ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py` (``simple_arctan_fit.py``)
-     - 00:00.325
+     - 00:00.334
      - 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.99660893 | 0.00206940 |       None |       None |   True
-                 k |    True | 0.98227444 | 0.08025824 |       None |       None |  False
-                x0 |    True | 0.03142528 | 0.07797092 |       None |       None |  False
+                 A |    True | 0.99871385 | 0.00211880 |       None |       None |   True
+                 k |    True | 0.96800069 | 0.08015125 |       None |       None |  False
+                x0 |    True | 0.03792893 | 0.08029446 |       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.325 seconds)
+   **Total running time of the script:** (0 minutes 0.334 seconds)
 
 
 .. _sphx_glr_download_auto_examples_model_fitting_simple_arctan_fit.py:

diff --git a/_sources/reference/material.rst.txt b/_sources/reference/material.rst.txt
@@ -18,7 +18,9 @@
 .. autoattribute:: exspy.material.elements
    :annotation:
 
-Database of element properties. The following properties are included:
+Database of element properties.
+
+The following properties are included:
 
 .. code::
 
@@ -32,32 +34,50 @@ Database of element properties. The following properties are included:
     └── Physical_properties
         └── density_gcm3
 
-Examples:
+The X-ray lines energies are taken from Chantler et al. [1]_.
 
-.. code::
+The line weight, more precisely the approximate line weight for K, L, M
+shells are taken from the Electron Probe Quantification (EPQ) library [2]_.
+
+The field ``threshold`` and ``edge`` are taken from the Gatan EELS atlas
+https://eels.info/atlas, as retrieved in June 2020.
+
+Examples
+
+>>> exspy.material.elements.Fe.General_properties
+├── Z = 26
+├── atomic_weight = 55.845
+└── name = iron
+>>> exspy.material.elements.Fe.Physical_properties
+└── density (g/cm^3) = 7.874
+>>> exspy.material.elements.Fe.Atomic_properties.Xray_lines
+├── Ka
+│   ├── energy (keV) = 6.404
+│   └── weight = 1.0
+├── Kb
+│   ├── energy (keV) = 7.0568
+│   └── weight = 0.1272
+├── La
+│   ├── energy (keV) = 0.705
+│   └── weight = 1.0
+├── Lb3
+│   ├── energy (keV) = 0.792
+│   └── weight = 0.02448
+├── Ll
+│   ├── energy (keV) = 0.615
+│   └── weight = 0.3086
+└── Ln
+    ├── energy (keV) = 0.62799
+    └── weight = 0.12525
+
+
+References
+
+.. [1] Chantler, C.T., Olsen, K., Dragoset, R.A., Kishore, A.R.,
+   Kotochigova, S.A., and Zucker, D.S. (2005), X-Ray Form Factor,
+   Attenuation and Scattering Tables (version 2.1).
+   https://dx.doi.org/10.18434/T4HS32
 
-    >>> exspy.material.elements.Fe.General_properties
-    ├── Z = 26
-    ├── atomic_weight = 55.845
-    └── name = iron
-    >>> exspy.material.elements.Fe.Physical_properties
-    └── density (g/cm^3) = 7.874
-    >>> exspy.material.elements.Fe.Atomic_properties.Xray_lines
-    ├── Ka
-    │   ├── energy (keV) = 6.404
-    │   └── weight = 1.0
-    ├── Kb
-    │   ├── energy (keV) = 7.0568
-    │   └── weight = 0.1272
-    ├── La
-    │   ├── energy (keV) = 0.705
-    │   └── weight = 1.0
-    ├── Lb3
-    │   ├── energy (keV) = 0.792
-    │   └── weight = 0.02448
-    ├── Ll
-    │   ├── energy (keV) = 0.615
-    │   └── weight = 0.3086
-    └── Ln
-        ├── energy (keV) = 0.62799
-        └── weight = 0.12525
+.. [2] Ritchie, N. EPQ is the Electron Probe Quantification library
+   - the basis for DTSA-II.
+   https://github.com/usnistgov/EPQ