\(\renewcommand\AA{\unicode{x212B}}\)
Framework Changes¶
Algorithms¶
New features¶
New algorithm EstimateScatteringVolumeCentreOfMass v1, allows user to estimate the centre of mass of the intersection between an illumination volume and a sample shape.
SNSPowderReduction has been updated to more correctly apply absorption corrections.
Add UpdateUB option to IndexPeaks v1 that enables saving the optimized UB matrix in the case where there is a single run and CommonUBForAll=False.
Bugfixes¶
Deprecated¶
LoadPreNexusLive has been deprecated. There is no replacement.
SCDCalibratePanels v1 has been deprecated, use SCDCalibratePanels v2 instead.
Removed¶
The algorithm ConvertUnitsUsingDetectorTable was deprecated in Release 3.9.0 and has now been removed.
Fit Functions¶
New features¶
Optimize the addTies function by implementing a single sort operation after all ties are added, rather than sorting the ties after each individual addition
Bugfixes¶
Deprecated¶
Removed¶
Data Objects¶
New features¶
Bugfixes¶
Python¶
New features¶
Added new python algorithm, TimeDifference v1, for calculating the time difference between a series of runs and a reference run.
Introduced a prototype “side-by-side” help system that includes both the legacy QtHelp-based viewer and a new Python-based Help Window using an embedded web browser (QWebEngine) to display documentation within Mantid Workbench.
Improvements:
Enhances the visual appearance and usability of in-app documentation.
Supports richer HTML content and modern formatting, including MathJax for rendering mathematical equations.
Delivers a smoother and more consistent experience when navigating help and reference material.
Key benefits:
Improved clarity for technical content (e.g. math and tables), more attractive and readable pages, and future potential for interactive elements in documentation.
Makes the large offline documentation an optional rather than a mandatory install, reducing installer/download size significantly.
Improvements:
For users who frequently access online docs or have bandwidth constraints, this saves considerable disk space (potentially hundreds of MB).
Those who prefer local/offline usage can still opt to install the documentation package and continue working without internet access.
A clear indicator has been added to the Help Window’s toolbar to show whether Mantid is displaying
Local DocsorOnline Docs.
Key benefits:
Greater flexibility in how Mantid is set up — you choose whether to save space or have full local, offline docs.
Bugfixes¶
Dependencies¶
New features¶
This release has removed all reliance on the NeXus API . Instead the
Fileclass was rewritten to use direct calls to the HDF5 API. In some places the C++ API (H5Cpp) is used for compatibility with other Mantid packages that also use the C++ API, but otherwise the low-level C API (hdf5) is used. This decision was made because:The C++ API is unsupported by the HDF Group (in private correspondence they suggested we use a 3rd party API).
The C++ API is not properly documented.
The C++ API does not have access to every possible feature or option that might be needed.
The C API is fully documented.
The C API is regularly maintained.
The C API is the “base” API for HDF5, and so automatically supports all available features natively.
Throughout this release cycle, we have been methodically replacing and modernizing the
Nexusabstraction layer, one piece of functionality at a time. This has included modern objects such as vectors and strings in place of arrays and C-strings, fixing many instances that apparently led to memory leaks due to unclosed objects, and simplifying the logic inside many of the methods for saving or loading data.This should not impact the observed behavior, except that memory should be more cleanly freed in Workbench, and loading or saving operations might run slightly faster.
Loading of HDF4 files is still handled by the read-only
LegacyNexuslayer.Those interested in the details of the changes can see them in the (developer centric) github issue or by following the Nexus tag.