Ticket #9370 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Update GeneratePythonScript to support nested algorithm history

Reported by: Samuel Jackson Owned by: Samuel Jackson
Priority: major Milestone: Release 3.2
Component: Framework Keywords:
Cc: Blocked By: #8913, #9369
Blocking: Tester: Nick Draper

Description

The GeneratePythonScript needs to be updated to support nested algorithm history. This includes the ability to unroll the history to a desired level and to add better formatting to the generated scripts. For more details see the nested history design document:

https://github.com/mantidproject/documents/blob/master/Design/Nested%20History%20Detailed%20Design%20Document.docx

Change History

comment:1 Changed 6 years ago by Owen Arnold

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Samuel Jackson

  • Blocking 9369 added

comment:3 Changed 6 years ago by Samuel Jackson

  • Blocking 9369 removed
  • Blocked By 9369 added

I've done this the other way round as generating a script from the GUI was a more complicated case and there's no easy way pass a parameter to unroll the history to different levels in a python script. Therefore, once the changes in #9369 pass, swap GeneratePythonScript to use the script building mechanism added in that ticket.

comment:4 Changed 6 years ago by Samuel Jackson

  • Blocking 9369 added
  • Blocked By 9369 removed

comment:5 Changed 6 years ago by Samuel Jackson

  • Blocking 9369 removed

comment:6 Changed 6 years ago by Samuel Jackson

  • Blocked By 9369 added

comment:7 Changed 6 years ago by Samuel Jackson

  • Blocking 9369 added
  • Blocked By 9369 removed

comment:8 Changed 6 years ago by Samuel Jackson

  • Blocking 9369 removed
  • Blocked By 9369 added

comment:9 Changed 6 years ago by Samuel Jackson

  • Status changed from assigned to inprogress

Refs #9370 Swap algorithm to use ScriptBuilder.

Changeset: 4b5b5cae97d0254e707a729c2c4ab56f925b6dec

comment:10 Changed 6 years ago by Samuel Jackson

Refs #9370 Update usage examples to match.

Changeset: 5077640b3d18ca81d63f94edb69d70b892b4dc57

comment:11 Changed 6 years ago by Samuel Jackson

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

To Test

There's no simple way to support nested algorithm history from GeneratePythonScript. But I have provided an option to unroll all of the history which defaults to being off so you just get the top level algorithms as usual.

  • Check the system/unit tests are passing.
  • Check using GeneratePythonScript on a workspace will reproduce the history of the top levle algorithms
  • Try the unroll all option on a workspace with a history with at least one Data Processor Algorithm in it and check you get all of the children output.

comment:12 Changed 6 years ago by Nick Draper

  • Status changed from verify to verifying
  • Tester set to Nick Draper

comment:13 Changed 6 years ago by Nick Draper

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9370_generate_python_script_nested_history'

Full changeset: e1e1880c48751ccabcdef6a7fbe42e8bc295f32c

comment:14 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10213

Note: See TracTickets for help on using tickets.