Merge pull request #13 from nexusformat/main

update from NIAC

.github/workflows/ci.yaml

@@ -4,12 +4,16 @@ on:
   push:
     branches:
       - main   # push commit to the main branch
-    tags:
-      - 'v2*'  # push tag starting with "v2" to the main branch
   pull_request:
     branches:
       - main   # pull request to the main branch
   workflow_dispatch:   # allow manual triggering
+    inputs:
+      deploy:
+        description: 'Deploy documentation'
+        type: boolean
+        required: true
+        default: false
 
 defaults:
   run:
@@ -33,7 +37,7 @@ jobs:
           fetch-depth: 0
 
       - name: Deploy Information
-        if: ${{ startsWith(github.ref, 'refs/tags') && env.python_version == '3.7' }}
+        if: ${{ github.event.inputs.deploy && env.python_version == '3.7' }}
         run: |
           echo "The HTML NeXus User Manual will be pushed to"
           echo " https://github.com/nexusformat/definitions/tree/gh-pages"
@@ -81,14 +85,14 @@ jobs:
           ls -lAFgh build/manual/build/latex/nexus.pdf
 
       - name: Build and Commit the User Manual
-        if: ${{ startsWith(github.ref, 'refs/tags') && env.python_version == '3.7' }}
+        if: ${{ github.event.inputs.deploy && env.python_version == '3.7' }}
         uses: sphinx-notes/pages@master
         with:
           # path to the conf.py directory
           documentation_path: build/manual/source
 
       - name: Deploy the User Manual
-        if: ${{ startsWith(github.ref, 'refs/tags') && env.python_version == '3.7' }}
+        if: ${{ github.event.inputs.deploy && env.python_version == '3.7' }}
         uses: ad-m/github-push-action@master
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

CHANGES.rst

@@ -22,6 +22,51 @@ Highlights of each release are described below.  For more details, see our wiki
 which provides links to the Release Notes (itemized list of changes) for any release.
 
 
+v2023.06
+++++++++
+
+expected *2023-06*
+
+New Features
+------------
+
+Add ``h5wasm`` and ``H5Web`` to HDF tools list.
+
+Allow ``recommended`` attribute as alias for ``optional``, but with the
+recommendation that this attribute be specified.
+
+NXxas: Added `NXdata/mode` to report detection method.
+
+Fixes
+-----------
+
+Added missing close parenthesis in rendering of suggested target.
+
+Maintenance
+-----------
+
+NXdata: clarify how errors are described in documentation.
+
+NXmx: clarify pixel size.
+
+NXsas: Various fields and groups changed to optional.  Only those deemed
+necessary for data reduction are required.
+
+NXtransformations: Add ``equipment_component`` attribute
+
+NXxas: `data` fields` changed from `NX_INT` to `NX_NUMBER`.
+
+NXxpcs: clarify use of ``entry_identifier``, ``entry_identifier_uuid``, and ``scan_number``.
+
+Deprecations
+------------
+
+NXdata: deprecate `errors` field in favor of `VARIABLE_errors` for the signal field.
+
+..
+  Contributors
+  ------------
+
 v2022.07
 ++++++++
 

applications/NXmx.nxdl.xml

@@ -457,7 +457,7 @@
                         <doc>
                             Boolean to indicate if the distance is a derived, rather than
                             a primary observation.  If distance_derived true or is not specified,
-                            the distance is assumed to be derived from delector axis
+                            the distance is assumed to be derived from detector axis
                             specifications.
                         </doc>
                     </field>
@@ -628,10 +628,25 @@
                     <field name="countrate_correction_applied" type="NX_BOOLEAN"
                         minOccurs="0">
                         <doc>
-                            True when a count-rate correction has already been applied in
-                            the data recorded here, false otherwise.
+                            Counting detectors usually are not able to measure all incoming particles,
+                            especially at higher count-rates. Count-rate correction is applied to
+                            account for these errors.
+
+                            True when count-rate correction has been applied, false otherwise.
                         </doc>
                     </field>
+                    <field name="countrate_correction_lookup_table" type="NX_NUMBER" >
+                        <doc>
+                            The countrate_correction_lookup_table defines the LUT used for count-rate
+                            correction. It maps a measured count :math:`c` to its corrected value
+                            :math:`countrate\_correction\_lookup\_table[c]`.
+
+                            :math:`m` denotes the length of the table.
+                        </doc>
+                        <dimensions rank="1">
+                            <dim index="1" value="m"/>
+                        </dimensions>
+                    </field>
                     <field name="virtual_pixel_interpolation_applied" type="NX_BOOLEAN"
                         minOccurs="0">
                         <doc>
@@ -691,7 +706,7 @@
                         </doc>
                     </field>
 
-                    <field name="saturation_value" type="NX_INT" minOccurs="0">
+                    <field name="saturation_value" type="NX_NUMBER" minOccurs="0">
                         <doc>
                             The value at which the detector goes into saturation.
                             Data above this value is known to be invalid.
@@ -702,7 +717,7 @@
                         </doc>
                     </field>
 
-                    <field name="underload_value" type="NX_INT" minOccurs="0">
+                    <field name="underload_value" type="NX_NUMBER" minOccurs="0">
                         <doc>
                             The lowest value at which pixels for this detector
                             would be reasonably be measured.