mantidproject / mantid

Main repository for Mantid code
https://www.mantidproject.org
GNU General Public License v3.0
211 stars 124 forks source link

Set `performancelog.filename` default to `algotimeregister.out` #38380

Closed robertapplin closed 1 week ago

robertapplin commented 2 weeks ago

Description of work

When I ran the mantid algorithm profiler for the first time in months, it wouldn't work because it couldn't find the output algotimeregister.out file. Through some digging I found out that the default had been (possibly accidentally) changed to algorithmregister.out so that it no longer matched with the default searched for by the mantid-profiler.

Additionally, everytime I rebuild mantid, this option will change, so I sometimes do my profiling (taking > 10 minutes), and then find out that the wrong output file was set in the Mantid.properties. This change makes sure that the default filename matches the performancelog filename expected by the algorithm profiler.

To test:

  1. Run the mantid-profiler on the following python script
from mantid.simpleapi import Load

filepath = "//olympic/Babylon5/Public/RobApplin/loading"
filename = "irs26176_graphite002_red_Conv_seq_2L_0-50__Result.nxs"

Load(
    Filename=f"{filepath}/{filename}",
    LoadHistory=True,
    OutputWorkspace="output_workspace",
)
  1. Make sure that the correct file (algotimeregister.out) is output in your working directory (or it might be in the build directory).

This does not require release notes because this is not user-facing

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/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.