Merge pull request #279 from FAIRmat-NFDI/update_optical_spec_website

Update optical spec website to include optical spectroscopy and raman
FAIRmat-NFDI · Aug 28, 2024 · 9d4af2f · 9d4af2f
2 parents f75a298 + 24b0d20
commit 9d4af2f
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 7 deletions.
diff --git a/dev_tools/docs/nxdl_index.py b/dev_tools/docs/nxdl_index.py
@@ -68,7 +68,7 @@ def nxdl_indices() -> Dict[str, dict]:
             print("---------++++++++-", section)
         if file.endswith("contributed_definitions/index.rst"):
             rst_lines.append(f"{indentation}em-structure\n")
-            rst_lines.append(f"{indentation}ellipsometry-structure\n")
+            rst_lines.append(f"{indentation}optical-spectroscopy-structure\n")
             rst_lines.append(f"{indentation}mpes-structure\n")
             rst_lines.append(f"{indentation}apm-structure\n")
             rst_lines.append(f"{indentation}transport-structure\n")
@@ -163,7 +163,7 @@ def get_nxclass_description(nxdl_file: Path, namespaces) -> str:
 and acceptance as either a base class or application definition.
 
 Some contributions are grouped together:
-  :ref:`Optical Spectroscopy <Ellipsometry-Structure>`
+  :ref:`Optical Spectroscopy <Optical-Spectroscopy-Structure>`
 
   :ref:`Multi-dimensional Photoemission Spectroscopy <Mpes-Structure>`
 

diff --git a/...ed_definitions/ellipsometry-structure.rst → ...itions/optical-spectroscopy-structure.rst b/...ed_definitions/ellipsometry-structure.rst → ...itions/optical-spectroscopy-structure.rst
@@ -1,4 +1,4 @@
-.. _Ellipsometry-Structure:
+.. _Optical-Spectroscopy-Structure:
 
 ====================
 Optical Spectroscopy

diff --git a/manual/source/index.rst b/manual/source/index.rst
@@ -14,7 +14,7 @@ https://www.nexusformat.org/
     nexus-index
     em-structure
     mpes-structure
-    ellipsometry-structure
+    optical-spectroscopy-structure
     apm-structure
     transport-structure
     sts-structure

diff --git a/manual/source/ellipsometry-structure.rst → ...source/optical-spectroscopy-structure.rst b/manual/source/ellipsometry-structure.rst → ...source/optical-spectroscopy-structure.rst
@@ -1,22 +1,49 @@
-.. _Ellipsometry-Structure-Fairmat:
+.. _Optical-Spectroscopy-Structure-Fairmat:
 
 ====================
 Optical spectroscopy
 ====================
 
 .. index::
+   OpticalSpec1
    Ellipsometry1
+   Raman1
    DispersiveMaterial1
 
+.. _OpticalSpec1:
+
+Optical Spectroscopy
+####################
+
+
+
+
+Application Definitions
+-----------------------
+
+We created one application definition:
+
+    :ref:`NXoptical_spectroscopy`:
+       A general application definition for optical spectroscopy measurements. This includes specifically:
+         photoluminescence
+         transmission spectroscopy
+         reflection spectroscopy
+         and general spectroscopy experiments
+
+   General spectroscopy experiments refer to experiments of the type photon-in photon-out. A detector is required to measure the "photon-out"-signal.
+   For Ellipsomertry and Raman spectroscopy are specific application definitions listed below.
+
+
+
 
 .. _Ellipsometry1:
 
 Ellipsometry
-##############
+############
 
 Ellipsometry is an optical characterization method to describe optical properties of interfaces and thickness of films. The measurements are based on determining how the polarization state of light changes upon transmission and reflection. Interpretation is based on Fresnel equations and numerical models of the optical properties of the materials.
 
-In the application definition we provide a minimum set of description elements allowing for a reproducible recording of ellipsometry measurements. 
+This application definition is an extension of :ref:`NXoptical_spectroscopy`. It provide a minimum set of description elements allowing for a reproducible recording of ellipsometry measurements. 
 
 
 Application Definitions
@@ -28,6 +55,27 @@ We created one application definition:
        A general application definition for ellipsometry measurements, including complex systems up to variable angle spectroscopic ellipsometry. 
 
 
+.. _Raman1:
+
+Raman spectroscopy
+##################
+
+Raman spectroscopy is an optical characterization method by measuring elastic light scattering. In this way phonon characteristics are measured for a extreme broad range of samples: gasses, liquids, solids, glasses, crystals. 
+
+The application definition provides an extension of :ref:`NXoptical_spectroscopy` to cover required or relevant data from Raman scattering experiments.
+
+
+Application Definitions
+-----------------------
+
+We created one application definition:
+
+    :ref:`NXraman`:
+       A general application definition for Raman measurements.
+
+
+
+
 Dispersive Material
 ###################