Changelog#

All notable changes to this project are documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased#

0.1.0b1 - 2026-11-16#

Added#

  • entry/data@default_slice so viewers open on the sinogram (translation vs rotation).

  • entry/data@interpretation to follow NXazint.

  • NXxrdct.data (NXdata class) with intensity, intensity_errors, radial_axis, and radial_axis_long_name.

  • Optional intensity errors (NXxrdct.data.intensity_errors) are stored in data/I_errors.

Changed#

  • NXxrdct.save() raises ValueError if:

    • data.intensity is missing or not 3D.

    • data.intensity_errors does not have the same shape as data.intensity.

    • An axis is missing or has the wrong length.

  • Integrated data is stored in data/I instead of instrument/detector/data.

  • The radial axis is stored in data/radial_axis instead of instrument/detector/radial_axis.

  • instrument/detector/data is now an optional external link to the raw detector images.

  • copy_nxxrdct_file updates a relative instrument/detector/data link so it still points to the raw images, and logs a warning if the raw file is not found.

  • radial_axis@long_name can now only be 2theta or q to follow NXazint1d.

Deprecated#

  • Setting NXxrdct.intensity, NXdetector.radial_axis, or NXdetector.radial_axis_long_name; use the matching NXxrdct.data fields.

Fixed#

  • Deprecation warnings now show the line in the user’s code that uses the deprecated name, instead of a line inside nxxrdct.

0.1.0b0 - 2026-09-30#

Added#

  • NXdetector.radial_axis_long_name added and is required when radial_axis is set. It has a value of either q or 2theta.

  • get_attribute helper in nxxrdct.utils to read HDF5 attributes.

Changed#

  • NXdetector.diffraction_channel is renamed radial_axis.

  • data/intensity is now a soft link to instrument/detector/data instead of a second copy of the array.

  • NXsample.rotation_angle is renamed rotation_angles.

  • Linting and formatting now use ruff only.

  • Angle @units are written in short form (deg) like the other fields.

Deprecated#

  • Setting NXxrdct.intensity; use instrument.detector.data.

  • Setting NXsample.rotation_angle; use rotation_angles.

  • Setting NXdetector.diffraction_channel; use radial_axis.

0.1.0a0 - 2026-01-25#

Added#

  • Initial NXxrdct API with NXentry, instrument, sample, and control objects.

  • NXmonochromator support with wavelength metadata.

  • Detector metadata for polar angles and diffraction channels.

  • Sample translation values metadata for XRD-CT axes.

  • NXdata intensity handling with axis linking and signal designation.

  • Paths/constants module for NXxrdct schema fields.

  • HDF5 utility helpers for reading datasets and quantities.

  • README quick start example for saving an NXxrdct entry.

  • Comprehensive unit tests for API objects, paths, utilities, and application I/O.