Skip to content

Conversation

robertapplin
Copy link
Contributor

@robertapplin robertapplin commented Oct 29, 2024

Description of work

This PR moves the LoadMuonNexus1 and LoadMuonNexus2 algorithms to the Framework/Muon library instead of Framework/DataHandling. These two algorithms are the only algorithms in Mantid used to load HDF4 Nexus files. The plan is to isolate these two algorithms within the Framework/Muon library, and then convert the code to use the HDF4 API directly instead of the Nexus API.

We want to remove the Nexus API for several reasons:

  • It is unsupported and has been unsupported for a number of years
  • We want to consolidate the ways in which we load nexus data into Mantid - and to do this we ultimately want a lightweight wrapper library around the HDF5 API, instead of using the current Nexus wrapper library and Nexus API we use.
  • Removing the use of Nexus API in favour of HDF5 API might have some speed benefits

Part of #38214

To test:

Complete the Muon Analysis test guide without issue
https://developer.mantidproject.org/Testing/MuonAnalysis_test_guides/index.html

Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@robertapplin robertapplin added ISIS: Spectroscopy Issue and pull requests relating to Muons, Indirect and Inelastic at ISIS Muon Issues and pull requests related to muons Maintenance Unassigned issues to be addressed in the next maintenance period. labels Oct 29, 2024
@robertapplin robertapplin added this to the Release 6.12 milestone Oct 29, 2024
@robertapplin robertapplin marked this pull request as ready for review October 29, 2024 09:23
@robertapplin robertapplin force-pushed the 38214-move-muon-hdf4-loaders-to-muon-target branch from d7214a1 to 74d4a59 Compare October 29, 2024 10:04
@robertapplin robertapplin force-pushed the 38214-move-muon-hdf4-loaders-to-muon-target branch from 81ebac8 to f479d29 Compare October 29, 2024 12:23
@robertapplin
Copy link
Contributor Author

No longer needed, going in a different direction

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ISIS: Spectroscopy Issue and pull requests relating to Muons, Indirect and Inelastic at ISIS Maintenance Unassigned issues to be addressed in the next maintenance period. Muon Issues and pull requests related to muons
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

2 participants