Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polarized SANS metadata: add SavePolarizedNXcanSAS to SANSSave #38523

Open
rbauststfc opened this issue Dec 18, 2024 · 0 comments
Open

Polarized SANS metadata: add SavePolarizedNXcanSAS to SANSSave #38523

rbauststfc opened this issue Dec 18, 2024 · 0 comments
Labels
ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS SANS Issues and pull requests related to SANS
Milestone

Comments

@rbauststfc
Copy link
Contributor

rbauststfc commented Dec 18, 2024

Part of #36147. See the design and requirements documents, and the NXcanSAS specification proposal, that are linked on that issue for more context and details of what needs to be implemented.

After adding a new SavePolarizedNXcanSAS algorithm we need to add it to the SANSSave algorithm. This will be the first step towards integrating this new save option into the SANS reduction.

The SavePolarizedNXcanSAS algorithm will have quite a lot of new input properties. To avoid adding this long list to SANSSave, we should investigate adding just a single additional property that will take a dictionary of the polarized metadata property values to be passed to SavePolarizedNXcanSAS. This would be something like the MergeRunsOptions property on the LoadAndMerge algorithm. We would need to pass a nested dictionary to SANSSave, which I think should be fine from a technical perspective, but we’ll need to double check.

From a usability perspective this approach is still not ideal, but I think we will expect people to use SavePolarizedNXcanSAS if they are using a save algorithm directly in their own scripts. From a maintainability perspective, this approach will hopefully make it easier to maintain and support developments to the SANS save algorithms in the future.

This issue should not be worked on until #38505 has been completed.

@rbauststfc rbauststfc added SANS Issues and pull requests related to SANS ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS labels Dec 18, 2024
@rbauststfc rbauststfc added this to the Release 6.13 milestone Dec 18, 2024
@rbauststfc rbauststfc moved this to Ready for Development in ISIS Polarised SANS Reduction Dec 18, 2024
@rbauststfc rbauststfc moved this from Ready for Development to Gathering Requirements in ISIS Polarised SANS Reduction Dec 18, 2024
@rbauststfc rbauststfc moved this from New to Backlog in ISIS LSS Sprint Planning Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS SANS Issues and pull requests related to SANS
Projects
Status: Backlog
Status: Gathering Requirements
Development

No branches or pull requests

1 participant