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 Dec 24, 2023
1 parent ab2d9aa commit a7c97b7
Show file tree
Hide file tree
Showing 30 changed files with 520 additions and 383 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -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: c8a97b085ea68b10b5ddb7cdce40fe68
config: 2b609d0afc009808ab2bc9e789d5bb22
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
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.
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ png file.

.. code-block:: none
0%| | 0.00/42.3M [00:00<?, ?B/s] 0%| | 11.3k/42.3M [00:00<10:14, 68.8kB/s] 0%| | 35.8k/42.3M [00:00<06:03, 116kB/s] 0%| | 84.0k/42.3M [00:00<03:34, 197kB/s] 0%| | 113k/42.3M [00:00<03:44, 188kB/s] 1%|▏ | 225k/42.3M [00:00<01:54, 366kB/s] 1%|▍ | 435k/42.3M [00:00<01:02, 674kB/s] 2%|▊ | 893k/42.3M [00:01<00:30, 1.36MB/s] 4%|█▌ | 1.78M/42.3M [00:01<00:15, 2.63MB/s] 8%|███ | 3.56M/42.3M [00:01<00:07, 5.19MB/s] 13%|████▉ | 5.67M/42.3M [00:01<00:04, 7.53MB/s] 18%|██████▋ | 7.60M/42.3M [00:01<00:03, 8.81MB/s] 23%|████████▍ | 9.63M/42.3M [00:01<00:03, 9.89MB/s] 27%|██████████▏ | 11.6M/42.3M [00:02<00:02, 10.5MB/s] 32%|███████████▉ | 13.7M/42.3M [00:02<00:02, 11.1MB/s] 37%|█████████████▋ | 15.6M/42.3M [00:02<00:02, 11.4MB/s] 42%|███████████████▍ | 17.7M/42.3M [00:02<00:02, 11.7MB/s] 47%|█████████████████▎ | 19.7M/42.3M [00:02<00:01, 11.9MB/s] 51%|███████████████████ | 21.7M/42.3M [00:02<00:01, 12.0MB/s] 56%|████████████████████▊ | 23.8M/42.3M [00:03<00:01, 12.1MB/s] 61%|██████████████████████▋ | 25.9M/42.3M [00:03<00:01, 12.2MB/s] 66%|████████████████████████▍ | 27.9M/42.3M [00:03<00:01, 12.3MB/s] 71%|██████████████████████████▏ | 30.0M/42.3M [00:03<00:00, 12.3MB/s] 76%|████████████████████████████ | 32.0M/42.3M [00:03<00:00, 12.4MB/s] 81%|█████████████████████████████▊ | 34.1M/42.3M [00:03<00:00, 12.5MB/s] 86%|███████████████████████████████▋ | 36.2M/42.3M [00:04<00:00, 12.5MB/s] 91%|█████████████████████████████████▍ | 38.3M/42.3M [00:04<00:00, 12.6MB/s] 95%|███████████████████████████████████▎ | 40.3M/42.3M [00:04<00:00, 12.5MB/s] 0%| | 0.00/42.3M [00:00<?, ?B/s] 100%|██████████████████████████████████████| 42.3M/42.3M [00:00<00:00, 281GB/s]
0%| | 0.00/42.3M [00:00<?, ?B/s] 0%| | 12.3k/42.3M [00:00<06:24, 110kB/s] 0%| | 41.0k/42.3M [00:00<03:36, 196kB/s] 0%| | 102k/42.3M [00:00<01:58, 356kB/s] 1%|▏ | 229k/42.3M [00:00<01:03, 661kB/s] 1%|▍ | 467k/42.3M [00:00<00:35, 1.18MB/s] 2%|▉ | 974k/42.3M [00:00<00:17, 2.31MB/s] 5%|█▋ | 1.97M/42.3M [00:00<00:09, 4.46MB/s] 9%|███▍ | 3.99M/42.3M [00:00<00:04, 8.75MB/s] 17%|██████▏ | 7.10M/42.3M [00:01<00:02, 14.7MB/s] 23%|████████▌ | 9.72M/42.3M [00:01<00:01, 17.3MB/s] 28%|██████████▌ | 12.0M/42.3M [00:01<00:01, 18.2MB/s] 35%|████████████▊ | 14.6M/42.3M [00:01<00:01, 19.8MB/s] 41%|███████████████ | 17.3M/42.3M [00:01<00:01, 20.9MB/s] 47%|█████████████████▎ | 19.8M/42.3M [00:01<00:01, 21.4MB/s] 53%|███████████████████▌ | 22.4M/42.3M [00:01<00:00, 21.8MB/s] 59%|█████████████████████▊ | 25.0M/42.3M [00:01<00:00, 22.2MB/s] 65%|████████████████████████ | 27.6M/42.3M [00:01<00:00, 22.5MB/s] 71%|██████████████████████████▎ | 30.1M/42.3M [00:02<00:00, 22.6MB/s] 77%|████████████████████████████▌ | 32.7M/42.3M [00:02<00:00, 22.7MB/s] 83%|██████████████████████████████▉ | 35.3M/42.3M [00:02<00:00, 22.7MB/s] 90%|█████████████████████████████████▏ | 37.9M/42.3M [00:02<00:00, 22.8MB/s] 96%|███████████████████████████████████▍ | 40.5M/42.3M [00:02<00:00, 23.0MB/s] 0%| | 0.00/42.3M [00:00<?, ?B/s] 100%|██████████████████████████████████████| 42.3M/42.3M [00:00<00:00, 290GB/s]
Expand Down Expand Up @@ -68,7 +68,7 @@ png file.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 11.813 seconds)
**Total running time of the script:** (0 minutes 8.819 seconds)


.. _sphx_glr_download_auto_examples_model_fitting_EELS_curve_fitting.py:
Expand Down
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 0x7fd352eb2ac0>
Exception ignored in: <function tqdm.__del__ at 0x7f5007437e20>
Traceback (most recent call last):
File "/opt/hostedtoolcache/Python/3.11.7/x64/lib/python3.11/site-packages/tqdm/std.py", line 1149, in __del__
self.close()
File "/opt/hostedtoolcache/Python/3.11.7/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, 1447.86it/s]
0%| | 0/10 [00:00<?, ?it/s] 100%|██████████| 10/10 [00:00<00:00, 1445.61it/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.566 seconds)
**Total running time of the script:** (0 minutes 0.534 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:12.745** total execution time for 3 files **from auto_examples/model_fitting**:
**00:09.715** 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:11.813
- 00:08.819
- 0.0
* - :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``plot_residual.py``)
- 00:00.566
- 00:00.534
- 0.0
* - :ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py` (``simple_arctan_fit.py``)
- 00:00.366
- 00:00.362
- 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 | 0.99752682 | 0.00215244 | None | None | True
k | True | 0.87765805 | 0.07006908 | None | None | False
x0 | True | -0.0446211 | 0.08590005 | None | None | False
A | True | 0.99776581 | 0.00196676 | None | None | True
k | True | 1.22255998 | 0.10646661 | None | None | False
x0 | True | 0.16163973 | 0.06647885 | 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.366 seconds)
**Total running time of the script:** (0 minutes 0.362 seconds)


.. _sphx_glr_download_auto_examples_model_fitting_simple_arctan_fit.py:
Expand Down
34 changes: 18 additions & 16 deletions _sources/intro.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Learning resources
:octicon:`rocket;2em;sd-text-info` Getting Started
^^^

New to HyperSpy or Python? The getting started guide provides an
introduction on basic usage of HyperSpy and how to install it.
New to exSpy or the HyperSpy ecosystem? The getting started guide provides an
introduction on basic usage of exSpy and how to install it.

.. grid-item-card::
:link: user_guide/index
Expand All @@ -37,7 +37,7 @@ Learning resources
:octicon:`book;2em;sd-text-info` User Guide
^^^

The user guide provides in-depth information on key concepts of HyperSpy
The user guide provides in-depth information on key concepts of exSpy
and how to use it along with background information and explanations.

.. grid-item-card::
Expand All @@ -48,7 +48,7 @@ Learning resources
^^^

Documentation of the metadata specification and of the Application Progamming Interface (API),
which describe how HyperSpy functions work and which parameters can be used.
which describe how exSpy functions work and which parameters can be used.

.. grid-item-card::
:link: auto_examples/index
Expand All @@ -57,16 +57,17 @@ Learning resources
:octicon:`zap;2em;sd-text-info` Example
^^^

Short examples illustrating simple tasks.
Gallery of short examples illustrating simple tasks that
can be performed with exSpy and HyperSpy.

.. grid-item-card::
:link: https://github.com/hyperspy/exspy-demos

:octicon:`workflow;2em;sd-text-info` Tutorials
^^^

Tutorials in form of Jupyter Notebooks to learn how to
process multi-dimensional data using HyperSpy.
Tutorials in form of Jupyter Notebooks to learn how to process
multi-dimensional electron/X-ray spectroscopy data using exSpy.

.. grid-item-card::
:link: contributing
Expand All @@ -75,29 +76,30 @@ Learning resources
:octicon:`people;2em;sd-text-info` Contributing
^^^

HyperSpy is a community project maintained for and by its users.
There are many ways you can help!
exSpy and the whole HyperSpy ecosystem are a community project
maintained for and by its users. There are many ways you can help!

Citing exSpy
============

If exSpy has been significant to a project that leads to an academic
publication, please acknowledge that fact by citing it. The DOI in the
badge below is the `Concept DOI <https://help.zenodo.org/faq/#versioning>`_ of
HyperSpy. It can be used to cite the project without referring to a specific
exSpy. It can be used to cite the project without referring to a specific
version. If you are citing exSpy because you have used it to process data,
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.592838.svg
:target: https://doi.org/10.5281/zenodo.592838
.. image:: https://zenodo.org/badge/doi/10.5281/zenodo.10252344.svg
:target: https://zenodo.org/doi/10.5281/zenodo.10252344

HyperSpy's citation in the scientific literature
Citation in the scientific literature
------------------------------------------------

Given the increasing number of articles that cite HyperSpy we do not maintain a list of
articles citing HyperSpy. For an up to date list search for
HyperSpy in a scientific database e.g. `Google Scholar
Given the increasing number of articles that cite HyperSpy and its extension
packages, we do not maintain a list of
articles citing exSpy or HyperSpy. For an up to date list search for
exSpy/HyperSpy in a scientific database e.g. `Google Scholar
<https://scholar.google.co.uk/scholar?q=hyperspy>`_.

.. Warning::
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:12.745** total execution time for 3 files **from all galleries**:
**00:09.715** 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:11.813
- 00:08.819
- 0.0
* - :ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py` (``../examples/model_fitting/plot_residual.py``)
- 00:00.566
- 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.366
- 00:00.362
- 0.0
Loading

0 comments on commit a7c97b7

Please sign in to comment.