From 03499a75ed1d651d69f590ed32635c010c6bd65b Mon Sep 17 00:00:00 2001 From: Ron Hildebrandt Date: Tue, 13 Aug 2024 16:03:39 +0200 Subject: [PATCH 1/6] Extension of Doc for Optical spectroscopy and Raman --- manual/source/ellipsometry-structure.rst | 50 +++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/manual/source/ellipsometry-structure.rst b/manual/source/ellipsometry-structure.rst index 255c3c5825..96d9e14717 100644 --- a/manual/source/ellipsometry-structure.rst +++ b/manual/source/ellipsometry-structure.rst @@ -5,9 +5,36 @@ 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: @@ -16,7 +43,7 @@ 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 NXoptical_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 ################### From bcbe7089ca5cf52dd0d19bbccedfc1a858f60463 Mon Sep 17 00:00:00 2001 From: Ron Hildebrandt Date: Tue, 13 Aug 2024 16:30:18 +0200 Subject: [PATCH 2/6] Update webpage for optical spectroscopy --- dev_tools/docs/nxdl_index.py | 2 +- manual/source/index.rst | 2 +- ...sometry-structure.rst => optical-spectroscopy-structure.rst} | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) rename manual/source/{ellipsometry-structure.rst => optical-spectroscopy-structure.rst} (99%) diff --git a/dev_tools/docs/nxdl_index.py b/dev_tools/docs/nxdl_index.py index 61725ced4e..3fe3ab554c 100644 --- 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\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") diff --git a/manual/source/index.rst b/manual/source/index.rst index d2d0ee59b8..a91669d024 100644 --- 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 apm-structure transport-structure sts-structure diff --git a/manual/source/ellipsometry-structure.rst b/manual/source/optical-spectroscopy-structure.rst similarity index 99% rename from manual/source/ellipsometry-structure.rst rename to manual/source/optical-spectroscopy-structure.rst index 96d9e14717..954c2a9ceb 100644 --- a/manual/source/ellipsometry-structure.rst +++ b/manual/source/optical-spectroscopy-structure.rst @@ -57,7 +57,7 @@ We created one application definition: .. _Raman1: -Raman NXoptical_spectroscopy +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. From 8b0520045c6a1740d839af3b5286ac2601837f08 Mon Sep 17 00:00:00 2001 From: Ron Hildebrandt Date: Wed, 14 Aug 2024 10:26:25 +0200 Subject: [PATCH 3/6] change ellips name to optical spec --- dev_tools/docs/nxdl_index.py | 2 +- ...sometry-structure.rst => optical-spectroscopy-structure.rst} | 2 +- manual/source/index.rst | 2 +- manual/source/optical-spectroscopy-structure.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) rename manual/source/classes/contributed_definitions/{ellipsometry-structure.rst => optical-spectroscopy-structure.rst} (99%) diff --git a/dev_tools/docs/nxdl_index.py b/dev_tools/docs/nxdl_index.py index 3fe3ab554c..b690be552a 100644 --- 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}optical-spectroscopy\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") diff --git a/manual/source/classes/contributed_definitions/ellipsometry-structure.rst b/manual/source/classes/contributed_definitions/optical-spectroscopy-structure.rst similarity index 99% rename from manual/source/classes/contributed_definitions/ellipsometry-structure.rst rename to manual/source/classes/contributed_definitions/optical-spectroscopy-structure.rst index f3b66a547d..183cc0e5bf 100644 --- a/manual/source/classes/contributed_definitions/ellipsometry-structure.rst +++ b/manual/source/classes/contributed_definitions/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 index a91669d024..962b7f6915 100644 --- a/manual/source/index.rst +++ b/manual/source/index.rst @@ -14,7 +14,7 @@ https://www.nexusformat.org/ nexus-index em-structure mpes-structure - optical-spectroscopy + optical-spectroscopy-structure apm-structure transport-structure sts-structure diff --git a/manual/source/optical-spectroscopy-structure.rst b/manual/source/optical-spectroscopy-structure.rst index 954c2a9ceb..c5ad40f4a2 100644 --- a/manual/source/optical-spectroscopy-structure.rst +++ b/manual/source/optical-spectroscopy-structure.rst @@ -1,4 +1,4 @@ -.. _Ellipsometry-Structure-Fairmat: +.. _Optical-Spectroscopy-Structure-Fairmat: ==================== Optical spectroscopy From c12d7c512fada687ff9faabb9298b5ad2cfa115c Mon Sep 17 00:00:00 2001 From: Ron Hildebrandt Date: Mon, 26 Aug 2024 10:52:55 +0200 Subject: [PATCH 4/6] fix_renaming_of_ellipsometry_to_optical_spec --- dev_tools/docs/nxdl_index.py | 2 +- .../source/optical-spectroscopy-structure.rst | 23 +++---------------- 2 files changed, 4 insertions(+), 21 deletions(-) diff --git a/dev_tools/docs/nxdl_index.py b/dev_tools/docs/nxdl_index.py index b690be552a..21cd999a96 100644 --- a/dev_tools/docs/nxdl_index.py +++ b/dev_tools/docs/nxdl_index.py @@ -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 ` + :ref:`Optical Spectroscopy ` :ref:`Multi-dimensional Photoemission Spectroscopy ` diff --git a/manual/source/optical-spectroscopy-structure.rst b/manual/source/optical-spectroscopy-structure.rst index c5ad40f4a2..5549890c44 100644 --- a/manual/source/optical-spectroscopy-structure.rst +++ b/manual/source/optical-spectroscopy-structure.rst @@ -4,18 +4,6 @@ Optical spectroscopy ==================== -.. index:: - OpticalSpec1 - Ellipsometry1 - Raman1 - DispersiveMaterial1 - -.. _OpticalSpec1: - -Optical Spectroscopy -############## - - Application Definitions @@ -35,11 +23,8 @@ We created one application definition: - -.. _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. @@ -51,14 +36,12 @@ Application Definitions We created one application definition: - :ref:`NXellipsometry`: - A general application definition for ellipsometry measurements, including complex systems up to variable angle spectroscopic ellipsometry. + 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. From 08b7a86e6b1ff6f23e492044f02a2a9e1d0bf147 Mon Sep 17 00:00:00 2001 From: Ron Hildebrandt Date: Mon, 26 Aug 2024 11:10:13 +0200 Subject: [PATCH 5/6] add missed links --- .../source/optical-spectroscopy-structure.rst | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/manual/source/optical-spectroscopy-structure.rst b/manual/source/optical-spectroscopy-structure.rst index 5549890c44..3551f29bcc 100644 --- a/manual/source/optical-spectroscopy-structure.rst +++ b/manual/source/optical-spectroscopy-structure.rst @@ -4,6 +4,18 @@ Optical spectroscopy ==================== +.. index:: + OpticalSpec1 + Ellipsometry1 + Raman1 + DispersiveMaterial1 + +.. _OpticalSpec1: + +Optical Spectroscopy +############## + + Application Definitions @@ -23,6 +35,9 @@ We created one application definition: + +.. _Ellipsometry1: + Ellipsometry ############ @@ -36,10 +51,12 @@ Application Definitions We created one application definition: - + :ref:`NXellipsometry`: A general application definition for ellipsometry measurements, including complex systems up to variable angle spectroscopic ellipsometry. +.. _Raman1: + Raman spectroscopy ################## From 24b0d20a5dfa49c5d3d8b1ee76daf4d3e54c8f9d Mon Sep 17 00:00:00 2001 From: Ron Hildebrandt Date: Mon, 26 Aug 2024 11:14:07 +0200 Subject: [PATCH 6/6] add missing #### in title... --- manual/source/optical-spectroscopy-structure.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manual/source/optical-spectroscopy-structure.rst b/manual/source/optical-spectroscopy-structure.rst index 3551f29bcc..c5d881d99c 100644 --- a/manual/source/optical-spectroscopy-structure.rst +++ b/manual/source/optical-spectroscopy-structure.rst @@ -13,7 +13,7 @@ Optical spectroscopy .. _OpticalSpec1: Optical Spectroscopy -############## +####################