diff --git a/.gitignore b/.gitignore index 1e25594542..fbf3fd897e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ # Hidden files .* !.github +!.readthedocs.yaml # Python byte / compiled / optimized *.py[cod] diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..fe110f1895 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,12 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.12" + commands: + - pip install -r requirements.txt + - make prepare + - make html + - mkdir -p $READTHEDOCS_OUTPUT/html + - cp -r build/manual/build/html/* $READTHEDOCS_OUTPUT/html/ diff --git a/contributed_definitions/NXauger_line.nxdl.xml b/contributed_definitions/NXauger_line.nxdl.xml new file mode 100644 index 0000000000..e494ca92b8 --- /dev/null +++ b/contributed_definitions/NXauger_line.nxdl.xml @@ -0,0 +1,976 @@ + + + + + + An Auger line describes a non-radiative decay process where an atom + with a core hole relaxes by filling the hole with an electron from a higher + energy level while simultaneously ejecting another electron (the Auger + electron). + + + + The Auger line name using either the notation ``INITIAL-FINAL1FINAL2`` + for a specific line or ``INITIAL-TOTAL`` (e.g. ``K-TOTAL``) for the + sum over all Auger lines originating from a given initial edge. + + The initial edge is one of: K, L1-L3, M1-M5. The two final edges range + from L through Q. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Kinetic energy of the emitted Auger electron. + + + + + The element undergoing the Auger transition. + + + \ No newline at end of file diff --git a/contributed_definitions/NXemission_line.nxdl.xml b/contributed_definitions/NXemission_line.nxdl.xml new file mode 100644 index 0000000000..f8c4a7bdca --- /dev/null +++ b/contributed_definitions/NXemission_line.nxdl.xml @@ -0,0 +1,631 @@ + + + + + + An emission line is a spectral line with a discrete frequency that is + characteristic of the emitting atom. + + + + The emission line name using either the `IUPAC notation`_, i.e. initial and final + edge separated by a hyphen (e.g. ``K-L3``), or the Latinized Siegbahn + notation (e.g. ``Ka1``). + + Correspondence between IUPAC and Siegbahn notations: + + .. list-table:: + :header-rows: 1 + + * - IUPAC + - Siegbahn + - Latinized Siegbahn + * - K-L3 + - :math:`K\alpha_1` + - Ka1 + * - K-L2 + - :math:`K\alpha_2` + - Ka2 + * - K-L1 + - :math:`K\alpha_3` + - Ka3 + * - K-M3 + - :math:`K\beta_1` + - Kb1 + * - K-N3 + - :math:`K\beta_2'` + - Kb2\' + * - K-N2 + - :math:`K\beta_2''` + - Kb2\'\' + * - K-M2 + - :math:`K\beta_3` + - Kb3 + * - K-N5 + - :math:`K\beta_4'` + - Kb4\' + * - K-N4 + - :math:`K\beta_4''` + - Kb4\'\' + * - K-N4 + - :math:`K\beta_{4x}` + - Kb4x + * - K-M5 + - :math:`K\beta_5'` + - Kb5\' + * - K-M4 + - :math:`K\beta_5''` + - Kb5\'\' + * - L3-M5 + - :math:`L\alpha_1` + - La1 + * - L3-M4 + - :math:`L\alpha_2` + - La2 + * - L2-M4 + - :math:`L\beta_1` + - Lb1 + * - L3-N5 + - :math:`L\beta_2` + - Lb2 + * - L1-M3 + - :math:`L\beta_3` + - Lb3 + * - L1-M2 + - :math:`L\beta_4` + - Lb4 + * - L3-O4,5 + - :math:`L\beta_5` + - Lb5 + * - L3-N1 + - :math:`L\beta_6` + - Lb6 + * - L3-O1 + - :math:`L\beta_7` + - Lb7 + * - L3-N6,7 + - :math:`L\beta_7'` + - Lb7\' + * - L1-M5 + - :math:`L\beta_9` + - Lb9 + * - L1-M4 + - :math:`L\beta_{10}` + - Lb10 + * - L3-N4 + - :math:`L\beta_{15}` + - Lb15 + * - L2-M3 + - :math:`L\beta_{17}` + - Lb17 + * - L2-N4 + - :math:`L\gamma_1` + - Lg1 + * - L1-N2 + - :math:`L\gamma_2` + - Lg2 + * - L1-N3 + - :math:`L\gamma_3` + - Lg3 + * - L1-O3 + - :math:`L\gamma_4` + - Lg4 + * - L1-O2 + - :math:`L\gamma_4'` + - Lg4\' + * - L2-N1 + - :math:`L\gamma_5` + - Lg5 + * - L2-O4 + - :math:`L\gamma_6` + - Lg6 + * - L2-O1 + - :math:`L\gamma_8` + - Lg8 + * - L2-N6,7 + - :math:`L\gamma_8'` + - Lg8\' + * - L2-M1 + - :math:`L\eta` + - Ln + * - L3-M1 + - :math:`Ll` + - Ll + * - L3-M3 + - :math:`Ls` + - Ls + * - L3-M2 + - :math:`Lt` + - Lt + * - L3-N6,7 + - :math:`Lu` + - Lu + * - L2-N6,7 + - :math:`Lv` + - Lv + * - M5-N7 + - :math:`M\alpha_1` + - Ma1 + * - M5-N6 + - :math:`M\alpha_2` + - Ma2 + * - M4-N6 + - :math:`M\beta` + - Mb + * - M3-N5 + - :math:`M\gamma` + - Mg + * - M4,5-N2,3 + - :math:`M\zeta` + - Mz + + .. _IUPAC notation: https://doi.org/10.1002/xrs.1300200308 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Energy of the emission line. + + + + + The element that emits this line. + + + \ No newline at end of file diff --git a/contributed_definitions/NXemission_lines.nxdl.xml b/contributed_definitions/NXemission_lines.nxdl.xml new file mode 100644 index 0000000000..28bdb7e142 --- /dev/null +++ b/contributed_definitions/NXemission_lines.nxdl.xml @@ -0,0 +1,37 @@ + + + + + + A container for grouping multiple emission lines. + + Each child :ref:`NXemission_line` group describes a single emission line. + + + + An emission line described by this collection. + + + \ No newline at end of file