add spell checker in CI/CD and Makefile

.github/workflows/spellcheck.yaml

@@ -0,0 +1,31 @@
+name: Spell Check
+
+on:
+  pull_request:
+    paths:
+      - "applications/**/*"
+      - "base_classes/**/*"
+      - "contributed_definitions/**/*"
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install dependencies and dictionary
+      run: |
+        npm install -g cspell jq @cspell/dict-scientific-terms-us
+
+    - name: Run cspell and format results
+      run: |
+        cspell --config cspell.json "applications/**/*" "base_classes/**/*" "contributed_definitions/**/*"
+
+    - name: Fail on errors
+      run: |
+        if [[ $? -ne 0 ]]; then
+          echo "There are spelling errors in your code. Please fix them and try again."
+          exit 1
+        fi

Makefile

@@ -28,6 +28,7 @@ help ::
 	@echo "make autoformat         Format all files to the coding style conventions."
 	@echo "make test               Run NXDL syntax and documentation tests."
 	@echo "make clean              Remove all build files."
+	@echo "make spellcheck         Run a spellcheck across all definitions."
 	@echo "make prepare            (Re)create all build files."
 	@echo "make html               Build HTML version of manual. Requires prepare first."
 	@echo "make pdf                Build PDF version of manual. Requires prepare first."
@@ -64,6 +65,11 @@ clean ::
 	$(RM) -rf $(APPDEF_DIR)/$(NYAML_SUBDIR)
 	$(RM) -rf $(CONTRIB_DIR)/$(NYAML_SUBDIR)
 
+spellcheck ::
+	@command -v cspell >/dev/null 2>&1 || { echo >&2 "cspell is not installed. Install it with: npm install -g cspell"; exit 1; }
+	@echo "Running spellcheck with cspell..."
+	cspell --config cspell.json "${APPDEF_DIR}/**/*" "${BASE_CLASS_DIR}/**/*" "${CONTRIB_DIR}/**/*"
+
 prepare ::
 	$(PYTHON) -m dev_tools manual --prepare --build-root $(BUILD_DIR)
 	$(PYTHON) -m dev_tools impatient --prepare --build-root $(BUILD_DIR)

applications/NXapm.nxdl.xml

@@ -187,7 +187,7 @@
         NXapm defines constraints on the existence and cardinality of concepts and its concept branches but seeks to
         offer a compromise. The key design pattern followed is that most branches are made optional or at most recommended
         but their child concepts are conditionally required. Thereby, NXapm can cover a variety of simple but also complex
-        use cases. An example of this parent-optional-but-childs-stronger-restricted design is the combination of the
+        use cases. An example of this parent-optional-but-children-stronger-restricted design is the combination of the
         optional group ``measurement`` with its required child ``measurement/instrument``:
         Users which report simulations are not forced to document the instrument but users which have characterized
         a specimen are motivated to report about the instrument. They are though not  necessarily required to report all
@@ -203,7 +203,7 @@
         events that can be time-stamped individually.
         Each instance of a group ``measurement/eventID`` contains ``measurement/instrument`` whose purpose is to
         store those specific state and settings of the instrument that was present during the collection of the event.
-        Thereby, changing conditions such as compaigns with different target detection rate can be stored.
+        Thereby, changing conditions such as campaigns with different target detection rate can be stored.
 
         Noteworthy, such an approach of the atom probe detecting groups of events and storing these as groups has also
         been in use in the proprietary software via CamecaRoot, a set of customized data structures and file formats that use

applications/NXarchive.nxdl.xml

@@ -3,7 +3,7 @@
 <!--
 # NeXus - Neutron and X-ray Common Data Format
 # 
-# Copyright (C) 2008-2024 NeXus International Advisory Committee (NIAC)
+# Copyright (C) 2008-2025 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

applications/NXcanSAS.nxdl.xml

@@ -3,7 +3,7 @@
 <!--
 # NeXus - Neutron and X-ray Common Data Format
 # 
-# Copyright (C) 2012-2024 NeXus International Advisory Committee (NIAC)
+# Copyright (C) 2012-2025 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

applications/NXdirecttof.nxdl.xml

@@ -3,7 +3,7 @@
 <!--
 # NeXus - Neutron and X-ray Common Data Format
 # 
-# Copyright (C) 2008-2024 NeXus International Advisory Committee (NIAC)
+# Copyright (C) 2008-2025 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

applications/NXem.nxdl.xml

@@ -89,7 +89,7 @@
         relevant. NXem defines constraints on the existence and cardinality of concepts and its concept branches
         but seeks to offer a compromise. The key design pattern followed is that most branches are made optional
         or at most recommended but their child concepts conditional required. Thereby, NXem can cover a variety
-        of simple but also complex use cases. An example of this parent-optional-but-childs-stronger-restricted design
+        of simple but also complex use cases. An example of this parent-optional-but-children-stronger-restricted design
         is the combination of the optional group ``measurement`` with its required child
         ``measurement/instrument``: Users which report simulations are not forced to document the instrument
         but users which have characterized a sample are motivated to report about the instrument. They are though not

applications/NXlauetof.nxdl.xml

@@ -3,7 +3,7 @@
 <!--
 # NeXus - Neutron and X-ray Common Data Format
 # 
-# Copyright (C) 2008-2024 NeXus International Advisory Committee (NIAC)
+# Copyright (C) 2008-2025 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

applications/NXmx.nxdl.xml

@@ -3,7 +3,7 @@
 <!--
   # NeXus - Neutron and X-ray Common Data Format
   #
-  # Copyright (C) 2013-2024 NeXus International Advisory Committee (NIAC)
+  # Copyright (C) 2013-2025 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

base_classes/NXatom.nxdl.xml

@@ -191,7 +191,7 @@
     <field name="nuclide_list" type="NX_UINT" units="NX_UNITLESS">
         <doc>
             Table which decodes the entries in nuclide_hash into a human-readable matrix
-            instances for either nuclids or elements. Specifically, the first row specifies the
+            instances for either nuclides or elements. Specifically, the first row specifies the
             nuclide mass number. When the nuclide_hash values are used this means
             the row should report the sum :math:`Z + N` or 0. The value 0 documents that
             an element from the IUPAC periodic table is meant.

base_classes/NXattenuator.nxdl.xml

@@ -3,7 +3,7 @@
 <!--
 # NeXus - Neutron and X-ray Common Data Format
 # 
-# Copyright (C) 2008-2024 NeXus International Advisory Committee (NIAC)
+# Copyright (C) 2008-2025 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

base_classes/NXcomponent.nxdl.xml

@@ -74,7 +74,7 @@
             via the NXtransformations group.
 
             NeXus positions components by applying a set of translations and rotations
-            to the component starting from 0, 0, 0. The order of these operations
+            to apply to the component starting from 0, 0, 0. The order of these operations
             is critical and forms what NeXus calls a dependency chain. The depends_on
             field defines the path to the top most operation of the dependency chain or the
             string "." if located in the origin. Usually these operations are stored in a

base_classes/NXelectromagnetic_lens.nxdl.xml

@@ -26,7 +26,7 @@
         Base class for an electro-magnetic lens or a compound lens.
 
         For :ref:`NXtransformations` the origin of the coordinate system is placed
-        in the center of the lens its polepiece, pinhole, or another point of reference.
+        in the center of the lens its pole piece, pinhole, or another point of reference.
         The origin should be specified in the :ref:`NXtransformations`.
 
         For details of electro-magnetic lenses in the literature see e.g.

base_classes/NXem_ebsd.nxdl.xml

@@ -78,7 +78,7 @@
         From this point onwards typically the microscope runs automatically.
 
         Diffraction pattern get collected until the queue finishes or gets interrupted by
-        either errors or arrival at the end of the users' allocated timeslot at the instrument.
+        either errors or arrival at the end of the users' allocated time slot at the instrument.
 
         Kikuchi pattern (EBSP) are usually indexed on-the-fly. These patterns are the raw data.
         Once indexed, these patterns are often not stored.

base_classes/NXpid_controller.nxdl.xml

@@ -44,7 +44,7 @@
         * K_ff
 
         A classic PID controller only implements the P, I and D terms and the values of the K_p, K_i and K_d constants are sufficient to fully
-        describe the behaviour of the feedback system implemented by such a PID controller. The inclusion of a Feed Forward term in a feedback system
+        describe the behavior of the feedback system implemented by such a PID controller. The inclusion of a Feed Forward term in a feedback system
         is a modern adaptation that aids optimization of the automated control. It is not present in all PID controllers, but it is also not uncommon.
 
         Note that the ``NXpid_controller`` is designed to be a child object of the actuator that its output is connected to. The parent object
@@ -130,7 +130,7 @@
             the Process Variable that is lower than the Setpoint results in a positive Error Value and a generally positive 
             control output that tells the actuator to push the value of the Process Variable upwards. In some implementations,
             the actuator will respond to a more positive control output by pushing the Process Variable towards lower values (e.g. 
-            a Peltier cooler) and so the output of the feedback system must be reversed to match the behaviour of the physical system.
+            a Peltier cooler) and so the output of the feedback system must be reversed to match the behavior of the physical system.
             A feedback system may also be implemented with reverse action in order to ensure that failures (e.g. disconnected sensor
             output or actuator input) result in a safe state (e.g. a valve should be left open to release pressure).
         </doc>

contributed_definitions/NXapm_composition_space_results.nxdl.xml

@@ -69,7 +69,7 @@
          check the respective group in the NXapm_paraprobe_results_nanochem data
          schema/application definition.
     </doc>
-    <!--by default for appdefs the value of the exists keyword is required
+    <!--by default for application definitions the value of the exists keyword is required
 unless it is explicitly specified differently-->
     <group type="NXentry" minOccurs="1" maxOccurs="1">
         <attribute name="version">
@@ -99,7 +99,7 @@ for if desired all the dependencies and libraries-->
         </field>
         <field name="description" optional="true">
             <doc>
-                 Disencouraged place for free-text for e.g. comments.
+                 Discouraged place for free-text for e.g. comments.
             </doc>
         </field>
         <field name="start_time" type="NX_DATE_TIME">
@@ -233,7 +233,7 @@ inspect the example of the NXem_ebsd application definition-->
                     </enumeration>
                 </field>
                 <field name="cardinality" type="NX_POSINT" units="NX_UNITLESS"/>
-                <!--default behaviour, if no coordinate system defined, unclear
+                <!--default behavior, if no coordinate system defined, unclear
 if one coordinate system is defined the origin is defined in this cs-->
                 <field name="origin" type="NX_NUMBER" units="NX_LENGTH">
                     <dimensions rank="1">

contributed_definitions/NXapm_paraprobe_config_clusterer.nxdl.xml

@@ -48,7 +48,7 @@ n_disjoint_clusters: Number of disjoint cluster.-->
          Configuration of a paraprobe-clusterer tool run in atom probe microscopy.
     </doc>
     <group type="NXentry">
-        <!--by default for appdefs the value of the exists keyword is required
+        <!--by default for application definitions the value of the exists keyword is required
 unless it is explicitly specified differently-->
         <attribute name="version">
             <doc>
@@ -146,7 +146,7 @@ unless it is explicitly specified differently-->
             <!--mapping_method:
   doc: |
     How should cluster labels be created from the cluster_labels information
-    especially when these areNcluste floating point values.
+    especially when these are Ncluster floating point values.
  enumeration: [take_as_is, use_dictionary]
 mapping_dictionary_keyword(NX_NUMBER):
   doc: |
@@ -294,7 +294,7 @@ mapping_dictionary_value(NX_UINT):
                      and how the multiplicity of each ion will be factorized.
 
                      This is relevant as in atom probe we have the situation that a ion
-                     of a molecular ion with more than one nuclid, say Ti O for example
+                     of a molecular ion with more than one nuclide, say Ti O for example
                      is counted such that although there is a single TiO molecular ion
                      at a position that the cluster has two members. This multiplicity
                      affects the size of the feature and chemical composition.

contributed_definitions/NXapm_paraprobe_config_intersector.nxdl.xml

@@ -31,7 +31,7 @@
          Configuration of a paraprobe-intersector tool run in atom probe microscopy.
     </doc>
     <group type="NXentry">
-        <!--by default for appdefs the value of the exists keyword is required
+        <!--by default for application definitions the value of the exists keyword is required
 unless it is explicitly specified differently-->
         <attribute name="version">
             <doc>
@@ -102,7 +102,7 @@ unless it is explicitly specified differently-->
                  Members of a so-called current_set to members of a so-called next_set.
                  Members can be different types of volumetric features.
                  In the analysis of M. Kuehbach et al. specifically features can be
-                 so-called objects (closed non-degnerated polyhedra representing watertight
+                 so-called objects (closed non-degenerated polyhedra representing watertight
                  parts of an e.g. iso-surface) and/or proxies. Proxies are computed
                  doppelganger/replacement meshes for parts of an iso-surface which initially
                  were not resulting in watertight meshes because objects at the edge
@@ -243,14 +243,14 @@ unless it is explicitly specified differently-->
                     </field>
                     <field name="groupname_geometry_prefix">
                         <doc>
-                             String whereby the path to the geometry data can be interferred automatically.
+                             String whereby the path to the geometry data can be inferred automatically.
                              Currently groupname_geometry_prefix/object&lt;ID&gt;/polyhedron.
                         </doc>
                     </field>
                     <field name="feature_identifier" type="NX_UINT" units="NX_UNITLESS">
                         <doc>
                              Array of identifier whereby the path to the geometry data
-                             can be interferred automatically.
+                             can be inferred automatically.
                         </doc>
                         <dimensions rank="1">
                             <dim index="1" value="i"/>
@@ -323,14 +323,14 @@ unless it is explicitly specified differently-->
                     </field>
                     <field name="groupname_geometry_prefix">
                         <doc>
-                             String whereby the path to the geometry data can be interferred automatically.
+                             String whereby the path to the geometry data can be inferred automatically.
                              Currently groupname_geometry_prefix/object&lt;ID&gt;/polyhedron.
                         </doc>
                     </field>
                     <field name="feature_identifier" type="NX_UINT" units="NX_UNITLESS">
                         <doc>
                              Array of identifier whereby the path to the geometry data
-                             can be interferred automatically.
+                             can be inferred automatically.
                         </doc>
                         <dimensions rank="1">
                             <dim index="1" value="j"/>

contributed_definitions/NXapm_paraprobe_config_nanochem.nxdl.xml

@@ -470,7 +470,7 @@ and this does not work because without a delocalization/field quantity you canno
                              `B. Gault et al. <https://doi.org/10.1017/S1431927621012952>`_ 
                              In continuation of these thoughts this applies also to reconstructed
                              objects. A well-known example is the discussion of shape deviations
-                             of Al3Sc precipitates in aluminium alloys which in reconstructions
+                             of Al3Sc precipitates in aluminum alloys which in reconstructions
                              can appear as ellipsoids although they should be almost spherical,
                              depending on their size.
                         </doc>

contributed_definitions/NXapm_paraprobe_config_ranger.nxdl.xml

@@ -42,7 +42,7 @@
          Configuration of a paraprobe-ranger tool run in atom probe microscopy.
     </doc>
     <group type="NXentry">
-        <!--by default for appdefs the value of the exists keyword is required
+        <!--by default for application definitions the value of the exists keyword is required
 unless it is explicitly specified differently-->
         <attribute name="version">
             <doc>
@@ -232,7 +232,7 @@ unless it is explicitly specified differently-->
                     <doc>
                          Report the accumulated atomic mass from each isotope building the ion.
                          Accounts for each identified ion.
-                         Relatistic effects are not accounted for.
+                         Relativistic effects are not accounted for.
                     </doc>
                 </field>
                 <field name="store_natural_abundance_product" type="NX_BOOLEAN">
@@ -241,7 +241,7 @@ unless it is explicitly specified differently-->
                          the ion. Accounts for each identified ion.
 
                          The value zero indicates it is not possible to build such molecular ion
-                         from nuclids which are all observationally stable.
+                         from nuclides which are all observationally stable.
                          Very small values can give an idea/about how likely such a molecular ion
                          is expected to form assuming equal probabilities.
 
@@ -267,7 +267,7 @@ store_composition_weighted_product(NX_BOOLEAN):
     It should not be forgotten though the computation relies on assumptions:
 
     * The composition is homogeneous within the virtual specimen.
-    * It is a priori know which nuclids the specimen is build of.
+    * It is a priori know which nuclides the specimen is build of.
 -->
                 <field name="store_charge_state" type="NX_BOOLEAN">
                     <doc>

contributed_definitions/NXapm_paraprobe_config_selector.nxdl.xml

@@ -31,7 +31,7 @@
          Configuration of a paraprobe-selector tool run in atom probe microscopy.
     </doc>
     <group type="NXentry">
-        <!--by default for appdefs the value of the exists keyword is required
+        <!--by default for application definitions the value of the exists keyword is required
 unless it is explicitly specified differently-->
         <attribute name="version">
             <doc>