From ccfb659b2408e08e439530faabab184016fb64a1 Mon Sep 17 00:00:00 2001 From: Florian Dobener Date: Thu, 4 Jul 2024 11:44:47 +0200 Subject: [PATCH 1/4] Add a reference to NXmpes from NXarpes (#153) * Add a reference to NXmpes to NXarpes * Make reference an actual rst link * Refer to `NXmpes_arpes` * modify reference to NXmpes_arpes --------- Co-authored-by: Lukas Pielsticker <50139597+lukaspie@users.noreply.github.com> # Conflicts: # applications/NXarpes.nxdl.xml # applications/nyaml/NXarpes.yaml --- applications/NXarpes.nxdl.xml | 246 ++++++++++++++++++---------------- 1 file changed, 133 insertions(+), 113 deletions(-) diff --git a/applications/NXarpes.nxdl.xml b/applications/NXarpes.nxdl.xml index f296bb477d..8d17472ad3 100644 --- a/applications/NXarpes.nxdl.xml +++ b/applications/NXarpes.nxdl.xml @@ -1,10 +1,10 @@ - - + + - - - This is an application definition for angular resolved photo electron spectroscopy. - - It has been drawn up with hemispherical electron analysers in mind. - - - - - NeXus convention is to use "entry1", "entry2", ... - for analysis software to locate each entry. - - - - - - Official NeXus NXDL schema to which this file conforms. - - - - - - - - - - - - - - - - - - - - - setting for the electron analyser lens - - - - - - - - - - - - - - - dial setting of the entrance slit - - - size of the entrance slit - - - energy of the electrons on the mean path of the analyser + + + This is an application definition for angular resolved photo electron spectroscopy. + + It has been drawn up with hemispherical electron analysers in mind. + + This definition is a legacy support for older NXarpes experiments. + There is, however, a newer definition to collect data & metadata + for general photoemission experiments, called :ref:NXmpes, + as well as a specialization for ARPES experiments, called :ref:NXmpes_arpes." + + + + + NeXus convention is to use "entry1", "entry2", ... + for analysis software to locate each entry. + + + + + + + Official NeXus NXDL schema to which this file conforms. + + + + - - todo: define more clearly - - - - Angular axis of the analyser data - which dimension the axis applies to is defined - using the normal NXdata methods. - - - - - Energy axis of the analyser data - which dimension the axis applies to is defined - using the normal NXdata methods. - - - - number of raw active elements in each dimension - - - - - - origin of rectangular region selected for readout - - - - - - size of rectangular region selected for readout - - - - - - - - - Descriptive name of sample - - + + + + + + + + + + + + + + + + + + setting for the electron analyser lens + + + + + + + + + + + + + + + + + dial setting of the entrance slit + + + + + size of the entrance slit + + + + + energy of the electrons on the mean path of the analyser + + + + + todo: define more clearly + + + + + Angular axis of the analyser data + which dimension the axis applies to is defined + using the normal NXdata methods. + + + + + Energy axis of the analyser data + which dimension the axis applies to is defined + using the normal NXdata methods. + + + + + number of raw active elements in each dimension + + + + + + + + origin of rectangular region selected for readout + + + + + + + + size of rectangular region selected for readout + + + + + + + + + + + Descriptive name of sample + + + + + - - From 549efb12329802d7075db0598bdba1d5452335f2 Mon Sep 17 00:00:00 2001 From: Lukas Pielsticker <50139597+lukaspie@users.noreply.github.com> Date: Mon, 16 Sep 2024 15:48:12 +0200 Subject: [PATCH 2/4] format base classes and applications in accordance to existing NIAC version # Conflicts: # applications/nyaml/NXarpes.yaml # base_classes/NXaperture.nxdl.xml # base_classes/NXbeam.nxdl.xml # base_classes/NXdata.nxdl.xml # base_classes/NXdetector.nxdl.xml # base_classes/NXentry.nxdl.xml # base_classes/NXenvironment.nxdl.xml # base_classes/NXinstrument.nxdl.xml # base_classes/NXmonochromator.nxdl.xml # base_classes/NXroot.nxdl.xml # base_classes/NXsample.nxdl.xml # base_classes/NXsample_component.nxdl.xml # base_classes/NXsensor.nxdl.xml # base_classes/NXsource.nxdl.xml # base_classes/NXsubentry.nxdl.xml # base_classes/NXtransformations.nxdl.xml # base_classes/NXuser.nxdl.xml # base_classes/nyaml/NXaperture.yaml # base_classes/nyaml/NXbeam.yaml # base_classes/nyaml/NXdata.yaml # base_classes/nyaml/NXdetector.yaml # base_classes/nyaml/NXentry.yaml # base_classes/nyaml/NXenvironment.yaml # base_classes/nyaml/NXinstrument.yaml # base_classes/nyaml/NXmonochromator.yaml # base_classes/nyaml/NXprocess.yaml # base_classes/nyaml/NXroot.yaml # base_classes/nyaml/NXsample.yaml # base_classes/nyaml/NXsample_component.yaml # base_classes/nyaml/NXsensor.yaml # base_classes/nyaml/NXsource.yaml # base_classes/nyaml/NXsubentry.yaml # base_classes/nyaml/NXtransformations.yaml # base_classes/nyaml/NXuser.yaml --- Makefile | 21 +-- applications/NXarpes.nxdl.xml | 253 ++++++++++++++++------------------ 2 files changed, 121 insertions(+), 153 deletions(-) diff --git a/Makefile b/Makefile index 3a882c2568..e1d0696fa5 100644 --- a/Makefile +++ b/Makefile @@ -60,9 +60,6 @@ test :: clean :: $(RM) -rf $(BUILD_DIR) - $(RM) -rf $(BASE_CLASS_DIR)/$(NYAML_SUBDIR) - $(RM) -rf $(APPDEF_DIR)/$(NYAML_SUBDIR) - $(RM) -rf $(CONTRIB_DIR)/$(NYAML_SUBDIR) prepare :: $(PYTHON) -m dev_tools manual --prepare --build-root $(BUILD_DIR) @@ -97,24 +94,10 @@ all :: @echo "HTML built: `ls -lAFgh $(BUILD_DIR)/manual/build/html/index.html`" @echo "PDF built: `ls -lAFgh $(BUILD_DIR)/manual/build/latex/nexus.pdf`" -$(BASE_CLASS_DIR)/%.nxdl.xml : $(BASE_CLASS_DIR)/$(NYAML_SUBDIR)/%.yaml - nyaml2nxdl $< --output-file $@ - -$(CONTRIB_DIR)/%.nxdl.xml : $(CONTRIB_DIR)/$(NYAML_SUBDIR)/%.yaml - nyaml2nxdl $< --output-file $@ - -$(APPDEF_DIR)/%.nxdl.xml : $(APPDEF_DIR)/$(NYAML_SUBDIR)/%.yaml - nyaml2nxdl $< --output-file $@ - -nxdl: $(YBC_NXDL_TARGETS) $(YCONTRIB_NXDL_TARGETS) $(YAPPDEF_NXDL_TARGETS) - -nyaml: - $(MAKE) -f nyaml.mk - # NeXus - Neutron and X-ray Common Data Format # -# Copyright (C) 2008-2024 NeXus International Advisory Committee (NIAC) +# Copyright (C) 2008-2022 NeXus International Advisory Committee (NIAC) # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public @@ -130,4 +113,4 @@ nyaml: # License along with this library; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # -# For further information, see http://www.nexusformat.org +# For further information, see http://www.nexusformat.org \ No newline at end of file diff --git a/applications/NXarpes.nxdl.xml b/applications/NXarpes.nxdl.xml index 8d17472ad3..e792d30adb 100644 --- a/applications/NXarpes.nxdl.xml +++ b/applications/NXarpes.nxdl.xml @@ -1,10 +1,10 @@ - - + + - - - This is an application definition for angular resolved photo electron spectroscopy. - - It has been drawn up with hemispherical electron analysers in mind. - - This definition is a legacy support for older NXarpes experiments. - There is, however, a newer definition to collect data & metadata - for general photoemission experiments, called :ref:NXmpes, - as well as a specialization for ARPES experiments, called :ref:NXmpes_arpes." - - - - - NeXus convention is to use "entry1", "entry2", ... - for analysis software to locate each entry. - - - - - - - Official NeXus NXDL schema to which this file conforms. - - - - + + + This is an application definition for angular resolved photo electron spectroscopy. + + It has been drawn up with hemispherical electron analysers in mind. + + This definition is a legacy support for older NXarpes experiments. + There is, however, a newer definition to collect data & metadata + for general photoemission experiments, called :ref:NXmpes, + as well as a specialization for ARPES experiments, called :ref:NXmpes_arpes." + + + + + NeXus convention is to use "entry1", "entry2", ... + for analysis software to locate each entry. + + + + + + Official NeXus NXDL schema to which this file conforms. + + + + + + + + + + + + + + + + + + + + + setting for the electron analyser lens + + + + + + + + + + + + + + + dial setting of the entrance slit + + + size of the entrance slit + + + energy of the electrons on the mean path of the analyser - - - - - - - - - - - - - - - - - - setting for the electron analyser lens - - - - - - - - - - - - - - - - - dial setting of the entrance slit - - - - - size of the entrance slit - - - - - energy of the electrons on the mean path of the analyser - - - - - todo: define more clearly - - - - - Angular axis of the analyser data - which dimension the axis applies to is defined - using the normal NXdata methods. - - - - - Energy axis of the analyser data - which dimension the axis applies to is defined - using the normal NXdata methods. - - - - - number of raw active elements in each dimension - - - - - - - - origin of rectangular region selected for readout - - - - - - - - size of rectangular region selected for readout - - - - - - - - - - - Descriptive name of sample - - - - - + + todo: define more clearly + + + + Angular axis of the analyser data + which dimension the axis applies to is defined + using the normal NXdata methods. + + + + + Energy axis of the analyser data + which dimension the axis applies to is defined + using the normal NXdata methods. + + + + number of raw active elements in each dimension + + + + + + origin of rectangular region selected for readout + + + + + + size of rectangular region selected for readout + + + + + + + + + Descriptive name of sample + + - + + + \ No newline at end of file From 04b09af2b771e617b208da539f3585690ded09dd Mon Sep 17 00:00:00 2001 From: Lukas Pielsticker <50139597+lukaspie@users.noreply.github.com> Date: Thu, 19 Sep 2024 11:28:11 +0200 Subject: [PATCH 3/4] change refs in NXarpes # Conflicts: # applications/nyaml/NXarpes.yaml --- applications/NXarpes.nxdl.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/applications/NXarpes.nxdl.xml b/applications/NXarpes.nxdl.xml index e792d30adb..9905347b5c 100644 --- a/applications/NXarpes.nxdl.xml +++ b/applications/NXarpes.nxdl.xml @@ -34,8 +34,8 @@ This definition is a legacy support for older NXarpes experiments. There is, however, a newer definition to collect data & metadata - for general photoemission experiments, called :ref:NXmpes, - as well as a specialization for ARPES experiments, called :ref:NXmpes_arpes." + for general photoemission experiments, called :ref:`NXmpes`, + as well as a specialization for ARPES experiments, called :ref:`NXmpes_arpes`." From bb5f9542af35db50bfcf0d387878b7761acd1983 Mon Sep 17 00:00:00 2001 From: Lukas Pielsticker <50139597+lukaspie@users.noreply.github.com> Date: Mon, 23 Sep 2024 16:51:10 +0200 Subject: [PATCH 4/4] revert unintentional changes from cherry-pick --- Makefile | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index e1d0696fa5..3a882c2568 100644 --- a/Makefile +++ b/Makefile @@ -60,6 +60,9 @@ test :: clean :: $(RM) -rf $(BUILD_DIR) + $(RM) -rf $(BASE_CLASS_DIR)/$(NYAML_SUBDIR) + $(RM) -rf $(APPDEF_DIR)/$(NYAML_SUBDIR) + $(RM) -rf $(CONTRIB_DIR)/$(NYAML_SUBDIR) prepare :: $(PYTHON) -m dev_tools manual --prepare --build-root $(BUILD_DIR) @@ -94,10 +97,24 @@ all :: @echo "HTML built: `ls -lAFgh $(BUILD_DIR)/manual/build/html/index.html`" @echo "PDF built: `ls -lAFgh $(BUILD_DIR)/manual/build/latex/nexus.pdf`" +$(BASE_CLASS_DIR)/%.nxdl.xml : $(BASE_CLASS_DIR)/$(NYAML_SUBDIR)/%.yaml + nyaml2nxdl $< --output-file $@ + +$(CONTRIB_DIR)/%.nxdl.xml : $(CONTRIB_DIR)/$(NYAML_SUBDIR)/%.yaml + nyaml2nxdl $< --output-file $@ + +$(APPDEF_DIR)/%.nxdl.xml : $(APPDEF_DIR)/$(NYAML_SUBDIR)/%.yaml + nyaml2nxdl $< --output-file $@ + +nxdl: $(YBC_NXDL_TARGETS) $(YCONTRIB_NXDL_TARGETS) $(YAPPDEF_NXDL_TARGETS) + +nyaml: + $(MAKE) -f nyaml.mk + # NeXus - Neutron and X-ray Common Data Format # -# Copyright (C) 2008-2022 NeXus International Advisory Committee (NIAC) +# Copyright (C) 2008-2024 NeXus International Advisory Committee (NIAC) # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public @@ -113,4 +130,4 @@ all :: # License along with this library; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # -# For further information, see http://www.nexusformat.org \ No newline at end of file +# For further information, see http://www.nexusformat.org