Merge branch 'main' into data_scalaroffset

nexusformat · Aug 20, 2024 · 3986074 · 3986074
2 parents 48ed5ef + 0e3421f
commit 3986074
Show file tree

Hide file tree

Showing 261 changed files with 367 additions and 292 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -42,6 +42,11 @@ jobs:
  with:
  fetch-depth: 0
 
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v4
+ with:
+ python-version: ${{ matrix.python-version }}
+
  - name: Deploy Information
  if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}
  run: |

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -22,10 +22,28 @@ 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
+v2024.02
 ++++++++
 
-expected *2023-06*
+released *2024-02-09*
+
+This release is the result of a NIAC meeting in 2022-09,
+NeXus Code Camps in 2022-06 and 2023-06,
+and substantial work by the NeXus Community, the FAIRmat consortium and NIAC members.
+
+Summary statistics from the GitHub definitions repository show
+this activity since the (previous) v2022.07 release:
+
+============= ========
+activity quantity
+============= ========
+Pull Requests 67
+Issues 34
+Commits 413
+============= ========
+
+See the wiki for more details:
+https://github.com/nexusformat/definitions/wiki/releasenotes__v2024.02
 
 New Features
 ------------
@@ -37,31 +55,68 @@ recommendation that this attribute be specified.
 
 NXxas: Added `NXdata/mode` to report detection method.
 
+Add various flux fields to NXbeam.
+
+Add virtual pixel handling to NXdetector.
+
+Add h5py example scripts.
+
+Add equipment_component attribute to NXtransformations.
+
+Add countrate_correction_lookup_table to NXdetector for NXmx.
+
+Allow axis fields to be numbers or strings and add a default_slice attribute to NXdata.
+
+Add new NXdetector_channel base class.
+
+Add favicon to manual web pages.
+
+Add many new contributed definitions from FAIRmat.
+
+Allow NeXus definitions to be created with YAML.
+
+Add recent contributors links to NeXus classes html pages.
+
+Improve link navigation in application definition items and collapse doc strings.
+
+
 Fixes
 -----------
 
-Added missing close parenthesis in rendering of suggested target.
+Add missing close parenthesis in rendering of suggested target.
+
+Amend text that mistakenly deprecated NXaperture.
+
+Generalize NXsource type for electron sources.
 
 Maintenance
 -----------
 
-NXdata: clarify how errors are described in documentation.
+NXdata: clarify how errors are described in documentation; remove obsolete dimension
+index attribute; clarify that attributes that name other fields must be existing
+children of group; improve documentation on axes.
 
-NXmx: clarify pixel size.
+NXmx: clarify pixel size, update NXbeam documentation on incident_wavelength_spectrum,
+make countrate_correction_lookup_table optional
 
-NXsas: Various fields and groups changed to optional.  Only those deemed
+NXsas: Various fields and groups changed to optional. Only those deemed
 necessary for data reduction are required.
 
-NXtransformations: Add ``equipment_component`` attribute
+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``.
+NXxpcs: clarify use of ``entry_identifier``, ``entry_identifier_uuid``, and ``scan_number``;
+fix some units.
+
+Clarify how NXbeam can be in NXinstrument groups or NXsample.
+
+
 
 Deprecations
 ------------
 
-NXdata: deprecate `errors` field in favor of `VARIABLE_errors` for the signal field.
+NXdata: deprecate `errors` field in favor of `FIELDNAME_errors` for the signal field.
 
 ..
  Contributors

diff --git a/Makefile b/Makefile
@@ -114,7 +114,7 @@ nyaml:
 
 # 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

diff --git a/NXDL_VERSION b/NXDL_VERSION
@@ -1 +1 @@
-v2022.07
+v2024.02
diff --git a/applications/NXarchive.nxdl.xml b/applications/NXarchive.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXarpes.nxdl.xml b/applications/NXarpes.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # NeXus - Neutron and X-ray Common Data Format
 # 
-# Copyright (C) 2012-2022 NeXus International Advisory Committee (NIAC)
+# Copyright (C) 2012-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

diff --git a/applications/NXcanSAS.nxdl.xml b/applications/NXcanSAS.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # NeXus - Neutron and X-ray Common Data Format
 # 
-# Copyright (C) 2012-2022 NeXus International Advisory Committee (NIAC)
+# Copyright (C) 2012-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

diff --git a/applications/NXdirecttof.nxdl.xml b/applications/NXdirecttof.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXfluo.nxdl.xml b/applications/NXfluo.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXindirecttof.nxdl.xml b/applications/NXindirecttof.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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
@@ -35,7 +35,7 @@
  <doc>Number of detectors</doc>
  </symbol>
  </symbols>
- <doc>This is a application definition for raw data from a direct geometry TOF spectrometer</doc>
+ <doc>This is a application definition for raw data from an indirect geometry TOF spectrometer</doc>
  <group type="NXentry" name="entry">
  <field name="title" />
  <field name="start_time" type="NX_DATE_TIME" />

diff --git a/applications/NXiqproc.nxdl.xml b/applications/NXiqproc.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXlauetof.nxdl.xml b/applications/NXlauetof.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXmonopd.nxdl.xml b/applications/NXmonopd.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXmx.nxdl.xml b/applications/NXmx.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
  # NeXus - Neutron and X-ray Common Data Format
  #
- # Copyright (C) 2013-2022 NeXus International Advisory Committee (NIAC)
+ # Copyright (C) 2013-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

diff --git a/applications/NXrefscan.nxdl.xml b/applications/NXrefscan.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXreftof.nxdl.xml b/applications/NXreftof.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXsas.nxdl.xml b/applications/NXsas.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXsastof.nxdl.xml b/applications/NXsastof.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXscan.nxdl.xml b/applications/NXscan.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXspe.nxdl.xml b/applications/NXspe.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
  # 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

diff --git a/applications/NXsqom.nxdl.xml b/applications/NXsqom.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXstxm.nxdl.xml b/applications/NXstxm.nxdl.xml
@@ -3,7 +3,7 @@
 <!-- 
  # NeXus - Neutron and X-ray Common Data Format
  # 
- # Copyright (C) 2014-2022 NeXus International Advisory Committee (NIAC)
+ # Copyright (C) 2014-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

diff --git a/applications/NXtas.nxdl.xml b/applications/NXtas.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXtofnpd.nxdl.xml b/applications/NXtofnpd.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXtofraw.nxdl.xml b/applications/NXtofraw.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXtofsingle.nxdl.xml b/applications/NXtofsingle.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXtomo.nxdl.xml b/applications/NXtomo.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXtomophase.nxdl.xml b/applications/NXtomophase.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXtomoproc.nxdl.xml b/applications/NXtomoproc.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXxas.nxdl.xml b/applications/NXxas.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXxasproc.nxdl.xml b/applications/NXxasproc.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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

diff --git a/applications/NXxbase.nxdl.xml b/applications/NXxbase.nxdl.xml
@@ -3,7 +3,7 @@
 <!--
 # 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