Ticket #11054 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Generate workflow diagrams with graphviz

Reported by: Harry Jeffery Owned by: Harry Jeffery
Priority: major Milestone: Release 3.4
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #11084 Tester: Pete Peterson

Description

See ​https://github.com/mantidproject/documents/blob/master/Design/Documentation/WorkflowDiagramGeneration.md

This ticket is an implementation of the design.

Change History

comment:1 Changed 6 years ago by Harry Jeffery

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Harry Jeffery

  • Status changed from assigned to inprogress

comment:3 Changed 6 years ago by Harry Jeffery

Refs #11054 Move diagram source files

Changeset: 6c00d0048243df9a3d44d63f90fa23d07810303f

comment:4 Changed 6 years ago by Harry Jeffery

Refs #11054 Add script to generate png files

Changeset: b96673831fe857eab71e75f9215c6af77d8d9950

comment:5 Changed 6 years ago by Harry Jeffery

Refs #11054 Add target for docs-diagrams

Changeset: 36b43c1a480d9b6e431ad1998078651227511c9c

comment:6 Changed 6 years ago by Harry Jeffery

Refs #11054 Use templated styles in Refl diagrams

Changeset: 6f1fba65ec37dbed6b4a7d620a3225b91a109c68

comment:7 Changed 6 years ago by Harry Jeffery

Refs #11054 Accept dot binary as argument

Changeset: 4553d7495c423034811c37c91c0f8398ca074737

comment:8 Changed 6 years ago by Harry Jeffery

Refs #11054 Find dot with CMake

Changeset: b586a4c9a207ca3180425d55fda76c6a8ebc180b

comment:9 Changed 6 years ago by Harry Jeffery

Refs #11054 Remove reflectometry diagram pngs

Changeset: cd98a9165a87158e6fa3771d465c6556872f2f7f

comment:10 Changed 6 years ago by Harry Jeffery

Refs #11054 Create diagram directive

Changeset: e3ea877e95ba5c8e307e154af7e61913cb8681eb

comment:11 Changed 6 years ago by Harry Jeffery

Refs #11054 Remove unused script

Changeset: 8fa7d7aacd2dfabe99d64fe7288108fc901d0a25

comment:12 Changed 6 years ago by Harry Jeffery

Refs #11054 Correct comments in diagram directive

Changeset: 0b033f9b01a3fda396ae816e392b3b6954df3433

comment:13 Changed 6 years ago by Harry Jeffery

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

This is being verified as ​pull request #202.

comment:14 Changed 6 years ago by Pete Peterson

FindDoxygen.cmake hands out the variable DOXYGEN_DOT_EXECUTABLE.

comment:15 Changed 6 years ago by Harry Jeffery

Refs #11054 Let doxygen find dot

Changeset: 560fe3787f2ff06b5085f858a495544aed20d250

comment:16 Changed 6 years ago by Pete Peterson

I tried your latest changes on my system and it works quite well. I think that the workflows should have a canonical name like ReflectometryReductionOne-v1_wkflw.dot (which becomes ReflectometryReductionOne-v1_wkflw.dot) so they are more parallel to the generated dialog boxes ReflectometryReductionOne-v1_dlg.png. The naming would be on the dot files rather than done by the sphinx extension.

If you want an extra challenge, AlignAndFocusPowder is already in (not your convention) dot.

comment:17 Changed 6 years ago by Harry Jeffery

Refs #11054 Use descriptive filenames for diagrams

Changeset: 6bfffcd021e9fa7515b8821068d958cb721c27a1

comment:18 Changed 6 years ago by Harry Jeffery

@peterfpeterson I've made the suggested changes, and another slight alteration. In the .. diagram:: directive the author now includes the .dot extension in the diagram name, making it more explicit that it's a filename, rather than a special name in a table somewhere.

`rst .. diagram:: ReflectometryReductionOne-v1_wkflw.dot .. diagram:: ReflectometryReductionOneAuto-v1-Groups_wkflw.dot .. diagram:: ReflectometryReductionOneAuto-v1-PolarizationCorrection_wkflw.dot `

It seems less confusing this way. I'm now writing the wiki page to document the new functionality.

comment:19 Changed 6 years ago by Harry Jeffery

The wiki page http://www.mantidproject.org/Documenting_Workflow_Algorithms has been updated to reflect the new approach. Some of the links are dead currently, but will come alive when this is merged.

comment:20 Changed 6 years ago by Harry Jeffery

Refs #11054 Add graphviz dependency to metapackages

Changeset: b0502958d29474bbeb9a9008a214e3f8817c6934

comment:21 Changed 6 years ago by Harry Jeffery

Jenkins, retest this please.

comment:22 Changed 6 years ago by Harry Jeffery

Jenkins, retest this please.

comment:23 Changed 6 years ago by Harry Jeffery

Jenkins, retest this please.

comment:24 Changed 6 years ago by Harry Jeffery

Jenkins, retest this please.

comment:25 Changed 6 years ago by Harry Jeffery

Jenkins, retest this please.

comment:26 Changed 6 years ago by Pete Peterson

  • Status changed from verify to verifying
  • Tester set to Pete Peterson

comment:27 Changed 6 years ago by Harry Jeffery

  • Blocking 11084 added

comment:28 Changed 6 years ago by Harry Jeffery

Refs #11054 Gracefully fail if dot unavailable

Changeset: 762314686e2151431cf532d7c7e61302fbc3437d

comment:29 Changed 6 years ago by Pete Peterson

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/11054_generate_workflow_diagrams_with_graphviz'

Full changeset: ​a06f484f5838b342ebef4227fa432379e2d72ed2

comment:30 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​11893

Note: See TracTickets for help on using tickets.