Skip to content

Generate Mermaid images directly#32

Open
dangunter wants to merge 5 commits intoprommis:mainfrom
dangunter:mermaid-image
Open

Generate Mermaid images directly#32
dangunter wants to merge 5 commits intoprommis:mainfrom
dangunter:mermaid-image

Conversation

@dangunter
Copy link
Copy Markdown
Contributor

Instead of asking the user to run scripts etc. themselves, use mermaid-cli to generate images directly.

Also simplify API generally and specifically for Mermaid diagrams.

@dangunter dangunter self-assigned this Mar 24, 2026
@dangunter dangunter requested a review from OOAmusat March 24, 2026 22:30
@dangunter
Copy link
Copy Markdown
Contributor Author

fyi, to use in a script/module:

from idaes_connectivity import MermaidImage

# build your model...
model = build_model()  

# create PNG file for model in 1 line!
MermaidImage(model).write("model.png")

@dangunter dangunter added the enhancement New feature or request label Mar 24, 2026
@ksbeattie ksbeattie added the Priority:Normal Normal Priority Issue or PR label Mar 30, 2026
@ksbeattie ksbeattie requested review from CopyDemon and esrawli March 30, 2026 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request Priority:Normal Normal Priority Issue or PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants