revert unintentional changes from cherry-pick

bring back files lost during cherry pick
nexusformat · Sep 23, 2024 · c840b48 · c840b48
1 parent c690fb2
commit c840b48
Show file tree

Hide file tree

Showing 10 changed files with 58 additions and 2,804 deletions.
diff --git 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
+# For further information, see http://www.nexusformat.org
diff --git a/base_classes/NXenvironment.nxdl.xml b/base_classes/NXenvironment.nxdl.xml
@@ -48,6 +48,17 @@
              Note, it is recommended to use NXtransformations instead.
         </doc>
     </group>
+    <field name="value" type="NX_FLOAT" units="NX_ANY">
+        <doc>
+             This is to be used if there is no actuator/sensor that controls/measures
+             the environment parameters, but the user would still like to give a value for
+             it. An example would be a room temperature experiment where the temperature is
+             not actively measured, but rather estimated.
+
+             Note that this method for recording the environment parameters is not advised,
+             but using NXsensor and NXactuator is strongly recommended instead.
+        </doc>
+    </field>
     <field name="depends_on" type="NX_CHAR">
         <doc>
             NeXus positions components by applying a set of translations and rotations
@@ -69,6 +80,29 @@
     <group type="NXnote">
         <doc>Additional information, LabView logs, digital photographs, etc</doc>
     </group>
-    <group type="NXsensor"/>
-</definition>
+    <group type="NXactuator">
+        <doc>
+             Any actuator used to control the environment. This can be linked to an actuator
+             defined in an NXinstrument instance.
+        </doc>
+    </group>
+    <group type="NXsensor">
+        <doc>
+             Any sensor used to monitor the environment. This can be linked to a sensor
+             defined in an NXinstrument instance.
+        </doc>
+    </group>
+    <attribute name="default">
+        <doc>
+             .. index:: plotting
 
+             Declares which child group contains a path leading
+             to a :ref:`NXdata` group.
+
+             It is recommended (as of NIAC2014) to use this attribute
+             to help define the path to the default dataset to be plotted.
+             See https://www.nexusformat.org/2014_How_to_find_default_data.html
+             for a summary of the discussion.
+        </doc>
+    </attribute>
+</definition>
diff --git a/contributed_definitions/NXcollectioncolumn.nxdl.xml b/contributed_definitions/NXcollectioncolumn.nxdl.xml
@@ -101,5 +101,4 @@
              Individual lenses in the collection column section
         </doc>
     </group>
-    <group type="NXfabrication"/>
 </definition>
diff --git a/contributed_definitions/NXelectronanalyser.nxdl.xml b/contributed_definitions/NXelectronanalyser.nxdl.xml
@@ -21,7 +21,7 @@
 #
 # For further information, see http://www.nexusformat.org
 -->
-<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXelectronanalyser" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
+<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" name="NXelectronanalyser" extends="NXobject" type="group" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
     <symbols>
         <doc>
              The symbols used in the schema to specify e.g. dimensions of arrays
@@ -154,5 +154,4 @@
              Individual lenses outside the main optics ensambles described by the subclasses
         </doc>
     </group>
-    <group type="NXfabrication"/>
 </definition>
diff --git a/contributed_definitions/NXenergydispersion.nxdl.xml b/contributed_definitions/NXenergydispersion.nxdl.xml
@@ -21,7 +21,7 @@
 #
 # For further information, see http://www.nexusformat.org
 -->
-<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXenergydispersion" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
+<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" name="NXenergydispersion" extends="NXobject" type="group" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
     <doc>
          Subclass of NXelectronanalyser to describe the energy dispersion section of a
          photoelectron analyser.
@@ -87,5 +87,4 @@
              Individual lenses in the energy dispersive section
         </doc>
     </group>
-    <group type="NXfabrication"/>
 </definition>
diff --git a/contributed_definitions/NXmanipulator.nxdl.xml b/contributed_definitions/NXmanipulator.nxdl.xml
@@ -21,7 +21,7 @@
 #
 # For further information, see http://www.nexusformat.org
 -->
-<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXmanipulator" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
+<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" name="NXmanipulator" extends="NXobject" type="group" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
     <doc>
          Extension of NXpositioner to include fields to describe the use of manipulators
          in photoemission experiments.
@@ -79,7 +79,6 @@
              Class to describe the motors that are used in the manipulator
         </doc>
     </group>
-    <group type="NXfabrication"/>
     <field name="depends_on" type="NX_CHAR">
         <doc>
              Refers to the last transformation specifying the positon of the manipulator in