Skip to content

38668 Disable Unsupported Rietveld Refinement Method from Diffraction Interface #39109

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

Conversation

JackEAllen
Copy link
Contributor

Description of work

Summary of work

  • Disable Rietveld Refinement Method within refinement_method_combobox on the GSAS-II tab in the Engineering and Diffraction Interface
  • Add on-hover tooltip to state that Rietveld is not currently supported

Fixes #38668

To test:

  • Open the Engineering Diffraction Interface Interfaces>>Diffraction>>Engineering Diffraction.
  • Go to the Calibration tab, select Create New Calibration.
  • For the Calibration Sample # enter 305738 and click the Calibrate button.
  • On the Focus tab, enter Sample Run # 305761 and Vanadium # 307521 and click the Focus button.
  • Change to the GSASII tab. The Instrument Group path should be pre-filled to a .prm file output by the calibration. and the Focused Data path should be pre-filled to the .gss file output from the Focus tab.
  • Enter a name into the Project Name e.g. Test.
  • For the Phase filepath, browse to MANTID_INSTALL_DIRECTORY/scripts/Engineering/ENGINX/phase_info/FE_GAMMA.cif.
  • Try to select Rietveld from the dropdown selections in Refinement Method - Validate that you cannot select Rietveld and that it is greyed out as a selection option.
  • Hover your curser over Rietveld in the Refinement Method dropdown selection and validate that the following message is displayed: "Rietveld is not currently supported."
  • Select Pawley from the Refinement Method dropdown.
  • Now, click Refine in GSAS II. After a few seconds, the output fit should be plotted.

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.

Disable Rietveld in . Add on-hover tooltip over disabled Rietveld method informing users that the method is not currently supported
@JackEAllen JackEAllen changed the title 38668 disable unsupported rietveld from diffraction interface 38668 Disable Unsupported Rietveld Refinement Method from Diffraction Interface Mar 27, 2025
@JackEAllen JackEAllen marked this pull request as ready for review March 27, 2025 10:06
@JackEAllen JackEAllen moved this to In Review in ISIS Diffraction Mar 27, 2025
@JackEAllen JackEAllen added this to the Release 6.13 milestone Mar 27, 2025
@cailafinn cailafinn self-assigned this Apr 2, 2025
@RichardWaiteSTFC RichardWaiteSTFC moved this to In Review in ISIS Diffraction Apr 3, 2025
Copy link
Contributor

@cailafinn cailafinn left a comment

Choose a reason for hiding this comment

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

Just a quick addition to the release notes. Otherwise (on macOS at least) the combobox option for Rietveld doesn't seem to be deactivated.

Disregard the above, it was due to a local pathing issue. Tested again and functionally this is working well.

Apologies this review took so long, it completely slipped off my list.

@JackEAllen JackEAllen force-pushed the 38668_disable_unsupported_Rietveld_from_diffraction_interface branch from 161e139 to 5e423e3 Compare April 10, 2025 10:12
@JackEAllen JackEAllen requested a review from cailafinn April 11, 2025 08:41
Copy link
Contributor

@cailafinn cailafinn left a comment

Choose a reason for hiding this comment

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

Works well when functionally tested; Unused option is now disabled. Code looks good to me. Nice work.

@SilkeSchomann SilkeSchomann self-assigned this Apr 16, 2025
@SilkeSchomann SilkeSchomann merged commit 10425c2 into main Apr 16, 2025
10 checks passed
@SilkeSchomann SilkeSchomann deleted the 38668_disable_unsupported_Rietveld_from_diffraction_interface branch April 16, 2025 08:29
@github-project-automation github-project-automation bot moved this from In Review to Done in ISIS Diffraction Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Crash in engineering diffraction's gasas2 tab
3 participants