Skip to content

REL: EbsdLib v3.1.4 Official Release - #86

Merged
imikejackson merged 1 commit into
BlueQuartzSoftware:developfrom
imikejackson:topic/next_release_fixes
Nov 13, 2026
Merged

imikejackson merged 1 commit into
BlueQuartzSoftware:developfrom
imikejackson:topic/next_release_fixes

Conversation

@imikejackson

@imikejackson imikejackson commented Nov 13, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

This branch combines every open EbsdLib fix branch except #62 (HDF5 2.x) into one branch for the next EbsdLib release, so that simplnx can build and test against one EbsdLib commit instead of many branches. It is the EbsdLib side of BlueQuartzSoftware/simplnx#1973, which builds and passes its full test suite against this branch.

Each original pull request is merged with --no-ff, so its commits and history are kept. The original pull requests are closed with a link to this one.

Merged pull requests

PR Title
#70 BUG: Set error messages in H5OIMReader and H5EspritReader (closes #69)
#72 BUG: Report an error when an ANG h5ebsd slice cannot be read
#73 BUG: Use one column count for a square-grid ANG file
#71 PERF: Measure the pole figure label width on a 1x1 canvas
#74 BUG: Load the embedded fonts once and check each font load
#64 BUG: getFZQuat returns one FZ quaternion for every equivalent orientation (fixes #63)
#60 ENH: Standard ODF section images and in-ball ODF sampling (contains all of #61)
#61 BUG: Correct ODF sampling and MDF normalization
#75 BUG: Report an error when a .cpr file defines no phases
#76 BUG: Reject invalid grid header values in the CTF and CPR readers
#77 ENH: Add a range-checked LaueOps lookup by crystal structure
#78 BUG: Reject an h5ebsd slice that is larger than the volume
#79 BUG: Reject non-positive Lambert projection and pole figure dimensions
#80 BUG: Clamp the quaternion scalar part before acos() in conversions
#81 DOC: Document the unit-length preconditions of orientation conversions
#82 BUG: Report an error when an ANG header number cannot be parsed
#83 BUG: Validate the pattern dataset in the Esprit and OIM HDF5 readers
#84 BUG: Reject an HDF5 lattice constants dataset that does not hold 6 values
#85 BUG: Report an error for a short ANG LatticeConstants or hklFamilies line

Conflict resolutions

New fix on this branch

  • H5CtfVolumeReader::getPhases() printed to std::cout and returned no phases with error code 0 when the slice header could not be read, for example for a phase with a LatticeConstants dataset that does not hold 6 values (BUG: Reject an HDF5 lattice constants dataset that does not hold 6 values #84). It now sets the slice reader's error code and message, as H5AngVolumeReader::getPhases() does. simplnx uses this message in its Read H5EBSD error. New test: H5LatticeConstantsTest::VolumeReaderGetPhases (fails without the change: 0 == -90350).

  • When EbsdLib was added as a subdirectory (simplnx with SIMPLNX_USE_LOCAL_EBSD_LIB=ON), it kept the parent project's DATA_ARCHIVE_WEB_SITE, which points to the simplnx archive site. Every EbsdLib test-data download failed with HTTP 404, so PoleFigureCompositorTest::All_Laue_Classes and DirectionalStatsTest:AverageOrientation failed. EbsdLib now uses its own variable, EBSDLIB_DATA_ARCHIVE_WEB_SITE. It takes DATA_ARCHIVE_WEB_SITE only when EbsdLib is the top-level project, so a standalone build bot that sets DATA_ARCHIVE_WEB_SITE keeps working.

API changes for callers

Test Plan

  • Linux x64, Release (ci-linux-x64): full ctest passes, 516/516, run serially.
  • clang-format 19.1.1: every changed C++ file is clean.
  • simplnx branch topic/next_ebsdlib_fixes built with SIMPLNX_USE_LOCAL_EBSD_LIB=ON against this branch and H5Support v1.0.14: full simplnx suite passes on Linux x64 Release (3972/3972; OrientationAnalysis 520/520). No simplnx exemplar result changed.
  • Windows x64, Release (MSVC 2022 14.44, Ninja, x64-windows-v143), built as a subdirectory of simplnx#1973: builds with no warnings in EbsdLib; EbsdLib tests pass 516/516, with both test archives downloaded from the EbsdLib archive site.
  • Standalone configure: the archives come from the EbsdLib site by default, and from DATA_ARCHIVE_WEB_SITE when it is set.
  • macOS build.
  • CI.

The bluequartz-skills plugin skills were not available in this environment.

After this merges

Release EbsdLib, update simplnx-registry, then update the simplnx vcpkg files.

🤖 Generated with Claude Code

This was referenced Nov 13, 2026
Fixed in this release:

BUG: Download the test data from the EbsdLib archive site in a subdirectory build
BUG: Report the slice reader's error from H5CtfVolumeReader::getPhases
TEST: Combine the LaueOpsTest additions from the merged branches
TEST: Combine the AngImportTest additions from the merged branches
BUG: Report an error for a short ANG LatticeConstants or hklFamilies line
BUG: Reject an HDF5 lattice constants dataset that does not hold 6 values
BUG: Validate the pattern dataset in the Esprit and OIM HDF5 readers
BUG: Report an error when an ANG header number cannot be parsed
DOC: Document the unit-length preconditions of orientation conversions
BUG: Clamp the quaternion scalar part before acos() in conversions
BUG: Reject non-positive Lambert projection and pole figure dimensions
BUG: Reject an h5ebsd slice that is larger than the volume
ENH: Add a range-checked LaueOps lookup by crystal structure
BUG: Reject invalid grid header values in the CTF and CPR readers
BUG: Report an error when a .cpr file defines no phases
COMP: Link canvas implementation into EbsdLib tests
BUG: Prevent clipping in ODF section axes
BUG: Preserve ODF glyphs and space axis labels
ENH: Refine ODF section annotations
BUG: Reject invalid ODF section grids
BUG: Correct ODF section input linearization
ENH: Add standard ODF section compositor
BUG: Validate ODF units and crop coverage
ENH: Add ODF section preparation utilities
BUG: Weight the random ODF baseline by each bin's in-ball volume
ENH: Expose ODF bin in-ball fractions and count homochoric clamp fallbacks
BUG: Remove obsolete axis orthorhombic LaueOps entry
ENH: Add generator-taking overloads for symmetry randomization and MDF sampling
BUG: Stop sampling ODF orientations from outside the homochoric ball
BUG: Keep CalculateMDFData normalized when MDF weights exceed the bin count
LIC: Update license for directional stats
BUG: Load the embedded fonts once and check that each font loads
PERF: Measure the pole figure label width on a 1x1 canvas
BUG: Use one column count for a square-grid ANG file
BUG: Report an error when an ANG h5ebsd slice cannot be read
BUG: Set error messages in H5OIMReader and H5EspritReader (BlueQuartzSoftware#69)
BUG: Map space groups 1-230 to the correct Laue class (BlueQuartzSoftware#67)
CI: Update to macOS 15 Build Bots (BlueQuartzSoftware#68)
@imikejackson
imikejackson force-pushed the topic/next_release_fixes branch from 069f421 to 88fb005 Compare November 13, 2026 15:37
@imikejackson
imikejackson merged commit d0f4769 into BlueQuartzSoftware:develop Nov 13, 2026
5 checks passed
@imikejackson
imikejackson deleted the topic/next_release_fixes branch November 13, 2026 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant