diff --git a/doc/intro.rst b/doc/intro.rst index 4d07730b5..15705a8b8 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -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 `_ library. It is aimed at helping with the analysis of X-rays Energy Dispersive Spectroscopy (EDS) diff --git a/doc/user_guide/eds.rst b/doc/user_guide/eds.rst index d87c2b97a..eee7ce488 100644 --- a/doc/user_guide/eds.rst +++ b/doc/user_guide/eds.rst @@ -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 @@ -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 @@ -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 @@ -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']) @@ -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') @@ -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) @@ -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])