Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-48395: Document newly added support for Mermaid graphs #462

Merged
merged 2 commits into from
Feb 5, 2025
Merged

DM-48395: Document newly added support for Mermaid graphs #462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
191cbbd
Clarify purpose of mermaid tools in docs
enourbakhsh Jan 13, 2025
de77370
Add a release note for mermaid support
enourbakhsh Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changes/DM-46503.feature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added Mermaid for pipeline and quantum graph visualization with tools for documentation/presentation purposes.
4 changes: 4 additions & 0 deletions python/lsst/pipe/base/mermaid_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ def _makeDatasetNode(dsRef: DatasetRef, allDatasetRefs: dict[str, str], file: An
def graph2mermaid(qgraph: QuantumGraph, file: Any) -> None:
"""Convert QuantumGraph into a Mermaid flowchart (top-down).

This method is mostly for documentation/presentation purposes.

Parameters
----------
qgraph : `~lsst.pipe.base.QuantumGraph`
Expand Down Expand Up @@ -301,6 +303,8 @@ def pipeline2mermaid(
This function produces a Mermaid flowchart, representing tasks and their
inputs/outputs as dataset nodes. It uses a top-down layout.

This method is mostly for documentation/presentation purposes.

Parameters
----------
pipeline : Pipeline or Iterable[TaskDef]
Expand Down
Loading