Skip to content

Conversation

cailafinn
Copy link
Contributor

Description of work

Summary of work

Add a system test to check the algorithm works consistently across OS' with real data files.

Fixes #37120

Further detail of work

Also adds the associated data files for running the algorithm properly. The code is set to ignore the error in the fit being quite high. This is intentional.

To test:

  • Run the algorithm locally using the ./build/systemtest -R DepolarizedAnalyserTransmission script.
    • This should download the testing data automatically, but re-running cmake and building the SystemTestData target manually may be required.
  • The algorithm should pass without issues.

This does not require release notes because there are no user-facing changes.


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.

@cailafinn cailafinn added SANS Issues and pull requests related to SANS ISIS: LSS Issue and pull requests relating to SANS and Reflectometry (Large Scale Structures) at ISIS labels Aug 30, 2024
@cailafinn cailafinn added this to the Release 6.11 milestone Aug 30, 2024
@cailafinn cailafinn marked this pull request as ready for review September 2, 2024 07:27
Copy link
Contributor

@jhaigh0 jhaigh0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can see the test runs fine in the ci job. One very minor readability thing

@jhaigh0 jhaigh0 self-assigned this Sep 2, 2024
@cailafinn cailafinn force-pushed the 37120_depolarized_analyser_trans_systest branch from 37b6741 to 1354494 Compare September 3, 2024 09:47
@cailafinn cailafinn force-pushed the 37120_depolarized_analyser_trans_systest branch from 1354494 to eaf12e6 Compare September 3, 2024 09:49
@cailafinn cailafinn requested a review from jhaigh0 September 3, 2024 11:14
Copy link
Contributor

@jhaigh0 jhaigh0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be easier for the algorithms in the test to use StoreInADS=False and then just assign the results to python variables?
If you want to use the ADS, is it easier to just clear the ADS in the cleanup method, rather than delete each test by name?

@cailafinn
Copy link
Contributor Author

Would it be easier for the algorithms in the test to use StoreInADS=False and then just assign the results to python variables? If you want to use the ADS, is it easier to just clear the ADS in the cleanup method, rather than delete each test by name?

Ah, thanks for the heads up, that's a better solution. I was hesitant to just clear the ADS so it didn't clear other tests. But thinking about it, I don't think they run on the same instance of the framework.

jhaigh0
jhaigh0 previously approved these changes Sep 4, 2024
Copy link
Contributor

@jhaigh0 jhaigh0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to go, the test failure in the CI is unrelated

@cailafinn cailafinn force-pushed the 37120_depolarized_analyser_trans_systest branch from 5f530d2 to b8b406f Compare September 5, 2024 15:26
@SilkeSchomann SilkeSchomann self-assigned this Sep 6, 2024
@SilkeSchomann SilkeSchomann merged commit bfc2608 into mantidproject:main Sep 6, 2024
10 checks passed
@cailafinn cailafinn deleted the 37120_depolarized_analyser_trans_systest branch September 6, 2024 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ISIS: LSS Issue and pull requests relating to SANS and Reflectometry (Large Scale Structures) at ISIS SANS Issues and pull requests related to SANS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a system test for DepolarizedAnalyserTransmission
3 participants