Ticket #7186 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Copying Algorithm history to Python does not copy Algorithm version

Reported by: Alex Buts Owned by: Harry Jeffery
Priority: major Milestone: Release 3.3
Component: Framework Keywords: student
Cc: Blocked By:
Blocking: Tester: Dan Nixon

Description (last modified by Nick Draper) (diff)

run simple script which calls version 1 of FFT_SMooth algorithm

Load(Filename=r'MAR11001.raw',OutputWorkspace='MAR11001',LoadMonitors='Separate')
Rebin(InputWorkspace='MAR11001_Monitors',OutputWorkspace='testWS1',Params='100,100,10000',PreserveEvents='0')
FFTSmooth(InputWorkspace='testWS1',OutputWorkspace='MAR11001_FFF',Params='100',Version=1)

Right click on MAR11001_FFF workspace, look at the workspace history and copy this history into clipboard.

The resulting script is:

Load(Filename=r'd:\Data\MantidSystemTests\Data\MAR11001.raw',OutputWorkspace='MAR11001',LoadMonitors='Separate')
Rebin(InputWorkspace='MAR11001_Monitors',OutputWorkspace='testWS1',Params='100,100,10000',PreserveEvents='0')
FFTSmooth(InputWorkspace='testWS1',OutputWorkspace='MAP15052_FFF',Params='100')



Executing it calls Version 2 of the algorithm FFTSmooth which is not what was requested.

Change History

comment:1 Changed 7 years ago by Nick Draper

  • Owner set to Anyone
  • Status changed from new to assigned

add versions to GenerateHistoryScript (or whatever the lag is called)

comment:2 Changed 7 years ago by Nick Draper

  • Status changed from assigned to new

comment:3 Changed 7 years ago by Nick Draper

  • Component changed from Mantid to Framework

comment:4 Changed 7 years ago by Nick Draper

  • Milestone changed from Release 2.6 to Backlog

Moved to backlog at the code freeze for R2.6

comment:5 Changed 7 years ago by Nick Draper

  • Status changed from new to assigned

Bulk move to assigned at the introduction of the triage step

comment:6 Changed 6 years ago by Nick Draper

  • Keywords student added
  • Description modified (diff)

I suggest we add an optional parameter to GeneratePythonScript to control how we handle versions with options:

  1. Use most recent
  2. Only if specified [default] (only include the version for algorithms that are not the most recent)
  3. Specify all

comment:7 Changed 6 years ago by Martyn Gigg

  • Milestone changed from Backlog to Release 3.3

comment:8 Changed 6 years ago by Harry Jeffery

  • Owner changed from Anyone to Harry Jeffery

comment:9 Changed 6 years ago by Harry Jeffery

  • Status changed from assigned to inprogress

Remove unused method declarations. Refs #7186

Changeset: d307d43f25ce53aab3959940e38c42087bf04e34

comment:10 Changed 6 years ago by Harry Jeffery

Add SpecifyAlgorithmVersions parameter. Refs #7186

Changeset: 0b6cf26763dbabb079d1f3ad1007b959cb9dc0d2

comment:11 Changed 6 years ago by Harry Jeffery

Implement SpecifyAlgorithmVersions parameter.

Refs #7186

Changeset: 72beb88ce497192cac4029a85873fa3d2463dfe0

comment:12 Changed 6 years ago by Harry Jeffery

Fix typo in help tooltip. Refs #7186

Changeset: 7846a1a070f5d7869b55053e3e7602e6957d6f60

comment:13 Changed 6 years ago by Harry Jeffery

  • Status changed from inprogress to verify
  • Resolution set to fixed

Testing

Run the first script in the ticket. Select the MAP15052_FFF workspace, select the GeneratePythonScript algorithm and press execute.

There is a new option: "SpecifyAlgorithmVersions" with three settings. "Specify All" will save the version for every algorithm, no matter what. "Specify Old" will save the versions of the algorithms used, but only if they are not the most recent. "Specify None" will never save the versions of the algorithms used, letting Mantid use the most recent ones by default when the script is executed.

Run the GeneratePythonScript algorithm once with each setting:

  • "Specify Old" should only add a version property to the FFTSmooth algorithm.
  • "Specify All" should add a version property to every algorithm.
  • "Specify None" should not add a version property to any algorithms.
Last edited 6 years ago by Harry Jeffery (previous) (diff)

comment:14 Changed 6 years ago by Samuel Jackson

  • Status changed from verify to verifying
  • Tester set to Samuel Jackson

comment:15 Changed 6 years ago by Samuel Jackson

  • Status changed from verifying to reopened
  • Resolution fixed deleted

comment:16 Changed 6 years ago by Harry Jeffery

  • Status changed from reopened to inprogress

Add version specification mode selector to UI.

More specifically, added it to the Algorithm History window.

Refs #7186

Changeset: c40e1fb88a0596c02a61faba312889b98a580df4

comment:17 Changed 6 years ago by Harry Jeffery

  • Status changed from inprogress to verify
  • Resolution set to fixed

comment:18 Changed 6 years ago by Nick Draper

  • Status changed from verify to verifying
  • Tester changed from Samuel Jackson to Nick Draper

comment:19 Changed 6 years ago by Nick Draper

  • Status changed from verifying to reopened
  • Resolution fixed deleted

On the Algorithm History Dialog the dropdown needs a label "Algorithm Versions"

comment:20 Changed 6 years ago by Harry Jeffery

  • Status changed from reopened to inprogress

Add algorithm versions label to Alg History Window

Refs #7186

Changeset: 93ab5835deb92366ce0c19bfb4849df935e5cad4

comment:21 Changed 6 years ago by Harry Jeffery

  • Status changed from inprogress to verify
  • Resolution set to fixed

comment:22 Changed 6 years ago by Dan Nixon

  • Status changed from verify to verifying
  • Tester changed from Nick Draper to Dan Nixon

comment:23 Changed 6 years ago by Dan Nixon

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/bugfix/7186_include_algorithm_version_in_history_script'

Full changeset: 987d9acf897ba156c845e32d42df3eaf4356f6e7

comment:24 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 8032

Note: See TracTickets for help on using tickets.