Stop hidden workspaces leaking to ADS during LoadAndMerge algorithm if run as child
#39214
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MialLewis
changed the title
LoadAndMerge algorithmLoadAndMerge algorithm if run as child
MialLewis
added
the
ISIS: LSS
adriazalvarez
requested changes
Apr 23, 2025
github-project-automation
bot
moved this from New
to In Progress
in ISIS LSS Sprint Planning
adriazalvarez
previously approved these changes
Apr 24, 2025
cailafinn
requested changes
Apr 24, 2025
docs/source/release/v6.13.0/Framework/Algorithms/Bugfixes/39041.rst
Outdated
Show resolved
Hide resolved
MialLewis
force-pushed
the
fix_refl_create_trans_leak
branch
from
3b9f363 to
a2bde87
Compare
cailafinn
approved these changes
Apr 25, 2025
github-project-automation
bot
moved this from In Progress
to Done
in ISIS LSS Sprint Planning
glass-ships
pushed a commit
that referenced
this pull request
Apr 25, 2025
… if run as child (#39214) * remove output workspaces from ads if child alg * expose getAlwaysStoreInADS to fix PolDiffILLReduction * add unit tests for LoadAndMerge ADS behaviour * respond to review comments
MialLewis
added
the
Reflectometry
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of work
Summary of work
This PR ensures that the
LoadAndMergealgorithm does not output workspaces to the ADS if run as a child algorithm, or theStoreInADSkeyword set to equalFalse.This behaviour was causing issues in algorithms down the line where hidden workspaces were being created in the ADS unexpectedly, contrary to specification.
To do this, I have exposed
getAlwaysStoreInADSto python, and simply remove output workspaces from the ADS at the end of the algorithm. In the short term this is preferable to making changes toMergeRunswhich would in all likelihood require more widespread changes to other algorithms. See: https://github.com/mantidproject/mantid/pull/39214/files#diff-a2152741e27e12b0ffd8a303849c522241c235238d6a500aef925ec3871b436cR117Fixes #39041
To test:
From
File>Settings> Turn onShow Invisible WorkspacesRun the following script (that uses
LoadAndMergeinternally: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
Functional Tests
Does everything look good? Mark the review as Approve. A member of
@mantidproject/gatekeeperswill 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.