gxformat2.mermaid package#

Module contents#

Mermaid flowchart visualization for Galaxy workflows.

gxformat2.mermaid.main(argv=None)[source]#

Entry point for generating Mermaid diagrams of Galaxy workflows.

gxformat2.mermaid.to_mermaid(workflow_path: str, output_path=None, *, comments: bool = False)[source]#

Produce mermaid output for the supplied workflow path.

gxformat2.mermaid.workflow_to_mermaid(workflow: dict[str, Any] | str | Path | GalaxyWorkflow | NormalizedFormat2, *, comments: bool = False) str[source]#

Convert a Galaxy workflow to a Mermaid flowchart string.

Accepts anything ensure_format2() supports, plus an already normalized NormalizedFormat2 instance.

When comments is True, FrameComment objects are rendered as Mermaid subgraphs that group their contained steps.