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.

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

Add to_mermaid function to covert flow to mermaid syntax #311

Merged
merged 7 commits into from
May 6, 2023
Merged

Conversation

utf
Copy link
Member

@utf utf commented May 6, 2023

Summary

Addresses #301

Based on @mkhorton's suggestion and code snippet, I've added a function to enable visualising Flow's in mermaid.

I made a few adjustments to allow for:

  • Nested flows and flow boxes
  • Supporting flows with no connections between jobs.

Examples

These may be of interest to @JaGeo. Note, the flow boxes are disabled by default but I've included them in these plots.

Phonon Workflow

phonon

Elastic workflow

elastic

Lobster workflow

lobster

Electron-phonon workflow

elph

@JaGeo
Copy link
Member

JaGeo commented May 6, 2023

@utf thank you! Very nice!

@codecov
Copy link

codecov bot commented May 6, 2023

Codecov Report

Merging #311 (367ea91) into main (de817d8) will not change coverage.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #311   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           19        19           
  Lines         1406      1429   +23     
  Branches       354       361    +7     
=========================================
+ Hits          1406      1429   +23     
Impacted Files Coverage Δ
src/jobflow/utils/graph.py 100.00% <100.00%> (ø)

@utf utf merged commit ecb73f2 into main May 6, 2023
@janosh janosh deleted the mermaid branch August 21, 2023 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants