update heading and index

OpenCOMPES · Mar 2, 2024 · dafc9ac · dafc9ac
1 parent 3ff86cb
commit dafc9ac
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 4 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,6 +13,10 @@ Concept description. TODO
 
    getting_started
    specsanalyzer/config
+   1_specsanalyzer_conversion_examples
+   2_specsscan_example
+   3_specsscan_conversion_to_NeXus
+   4_specsscan_load_sweep_scan
 
 .. toctree::
    :maxdepth: 1

diff --git a/tutorial/1_specsanalyzer_conversion_examples.ipynb b/tutorial/1_specsanalyzer_conversion_examples.ipynb
@@ -4,7 +4,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## This is an example showcasing the conversion of Phoibos analyzer data with SpecsAnalyzer\n",
+    "## Example 1: SpecsAnalyzer conversion\n",
+    "This is an example showcasing the conversion of Phoibos analyzer data with SpecsAnalyzer\n",
+    "\n",
     "The image is loaded from a text file, and the conversion into xarrays with calibrated dimensions is demonstrated for different modes of operation "
    ]
   },

diff --git a/tutorial/2_specsscan_example.ipynb b/tutorial/2_specsscan_example.ipynb
@@ -5,7 +5,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## This is an example showcasing the loading of trARPES data as collected using the Phoibos detector at FHI Berlin.\n",
+    "## Example: SpecsScan loading\n",
+    "This is an example showcasing the loading of trARPES data as collected using the Phoibos detector at FHI Berlin.\n",
+    "\n",
     "The band dispersion is loaded as a xarray dataframe demonstrating different modes of operation "
    ]
   },

diff --git a/tutorial/3_specsscan_conversion_to_NeXus.ipynb b/tutorial/3_specsscan_conversion_to_NeXus.ipynb
@@ -4,7 +4,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## This is an example showcasing the loading of a tilt map Fermi surface mapping\n",
+    "## Example 3: Export to NeXus\n",
+    "This is an example showcasing the loading of a tilt map Fermi surface mapping\n",
+    "\n",
     "The band dispersion is loaded as a xarray dataframe following a conversion to the [NXmpes_arpes NeXus format](https://manual.nexusformat.org/classes/contributed_definitions/NXmpes.html#nxmpes) using the [FAIRmat pynxtools](https://github.com/FAIRMAT-nfdi/pynxtools)."
    ]
   },

diff --git a/tutorial/4_specsscan_load_sweep_scan.ipynb b/tutorial/4_specsscan_load_sweep_scan.ipynb
@@ -5,7 +5,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## This is an example showcasing the loading of a kinetic energy sweep scan\n",
+    "## Example 4: Sweep Scan loading\n",
+    "This is an example showcasing the loading of a kinetic energy sweep scan\n",
+    "\n",
     "The individual images are loaded, and summed onto the grid of data that overlap on all images"
    ]
   },