Skip to content

Commit

Permalink
fix eXSpy in code examples
Browse files Browse the repository at this point in the history
  • Loading branch information
jlaehne committed Feb 14, 2024
1 parent 11eaaeb commit 07b2a74
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions doc/intro.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Welcome to eXSpy's documentation!
***********************************
Welcome to the documentation of eXSpy!
**************************************
**eXSpy** is a Python package extending the functionality for multi-dimensional
data analysis provided by the `HyperSpy <https://hyperspy.org/>`_ library. It is
aimed at helping with the analysis of X-rays Energy Dispersive Spectroscopy (EDS)
Expand Down
16 changes: 8 additions & 8 deletions doc/user_guide/eds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,13 +149,13 @@ will be set by default. These default values can be changed in the

.. code-block:: python
>>> eXSpy.preferences.EDS.eds_detector_elevation = 37
>>> exspy.preferences.EDS.eds_detector_elevation = 37
or through the GUI:

.. code-block:: python
>>> eXSpy.preferences.gui()
>>> exspy.preferences.gui()
.. figure:: images/EDS_preferences_gui.png
:align: center
Expand Down Expand Up @@ -222,7 +222,7 @@ The description of the sample is also stored in the

.. code-block:: python
>>> s = eXSpy.data.EDS_TEM_FePt_nanoparticles()
>>> s = exspy.data.EDS_TEM_FePt_nanoparticles()
>>> s.add_lines()
>>> s.metadata.Sample.thickness = 100
>>> s.metadata.Sample
Expand All @@ -247,7 +247,7 @@ abbreviations are accepted:

.. code-block:: python
>>> s = eXSpy.data.EDS_TEM_FePt_nanoparticles()
>>> s = exspy.data.EDS_TEM_FePt_nanoparticles()
>>> s.set_elements(['Fe', 'Pt'])
>>> s.add_elements(['Cu'])
>>> s.metadata.Sample
Expand All @@ -264,7 +264,7 @@ Several lines per element can be defined at once.

.. code-block:: python
>>> s = eXSpy.data.EDS_TEM_FePt_nanoparticles()
>>> s = exspy.data.EDS_TEM_FePt_nanoparticles()
>>> s.set_elements(['Fe', 'Pt'])
>>> s.set_lines(['Fe_Ka', 'Pt_La'])
>>> s.add_lines(['Fe_La'])
Expand Down Expand Up @@ -476,7 +476,7 @@ Finally, the windows of integration can be visualised using

.. code-block:: python
>>> s = eXSpy.data.EDS_TEM_FePt_nanoparticles().isig[5.:13.]
>>> s = exspy.data.EDS_TEM_FePt_nanoparticles().isig[5.:13.]
>>> s.add_lines()
>>> s.plot(integration_windows='auto')
Expand Down Expand Up @@ -504,7 +504,7 @@ using :py:meth:`~.signals.EDSSpectrum.plot`:

.. code-block:: python
>>> s = eXSpy.data.EDS_TEM_FePt_nanoparticles().isig[5.:13.]
>>> s = exspy.data.EDS_TEM_FePt_nanoparticles().isig[5.:13.]
>>> s.add_lines()
>>> bw = s.estimate_background_windows(line_width=[5.0, 2.0])
>>> s.plot(background_windows=bw)
Expand Down Expand Up @@ -700,7 +700,7 @@ out as follows:

.. code-block:: python
>>> s = eXSpy.data.EDS_TEM_FePt_nanoparticles()
>>> s = exspy.data.EDS_TEM_FePt_nanoparticles()
>>> s.add_lines()
>>> kfactors = [1.450226, 5.075602] #For Fe Ka and Pt La
>>> bw = s.estimate_background_windows(line_width=[5.0, 2.0])
Expand Down

0 comments on commit 07b2a74

Please sign in to comment.