📊 Plotly Sankey #3711

chris-ashe · 2025-07-09T13:21:45Z

This pull request introduces a new interactive Sankey diagram plotting feature using Plotly and updates the documentation and codebase to use it instead of the previous Sankey plotting method. The most important changes are summarized below:

Documentation updates

Added a new section to documentation/usage/plotting.md describing how to use the plot_plotly_sankey script to generate an interactive HTML Sankey diagram for plant power balance, including usage instructions and an example figure.

Codebase changes

Updated imports in process/main.py to include plot_plotly_sankey and removed the import of the old plot_sankey module.
Changed the post-processing workflow in process/main.py to call plot_plotly_sankey.main() for generating Sankey diagrams, commenting out the old plot_sankey.main() call.

Checklist

I confirm that I have completed the following checks:

My changes follow the PROCESS style guide
I have justified any large differences in the regression tests caused by this pull request in the comments.
I have added new tests where appropriate for the changes I have made.
If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
If I have made documentation changes, I have checked they render correctly.
I have added documentation for my change, if appropriate.

codecov-commenter · 2025-07-09T13:42:25Z

Codecov Report

❌ Patch coverage is 29.16667% with 34 lines in your changes missing coverage. Please review.
✅ Project coverage is 44.20%. Comparing base (68d8058) to head (dc756c9).
⚠️ Report is 97 commits behind head on main.

Files with missing lines	Patch %	Lines
process/io/plot_plotly_sankey.py	28.26%	33 Missing ⚠️
process/main.py	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3711      +/-   ##
==========================================
- Coverage   46.67%   44.20%   -2.48%     
==========================================
  Files         122      123       +1     
  Lines       27804    31084    +3280     
==========================================
+ Hits        12977    13740     +763     
- Misses      14827    17344    +2517

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…ce node and link color definitions, and improve layout settings

…lanket neutron multiplication

…E' and enhance naming convention

…ance readability

… plot_plotly_sankey for improved visualization

…s and example for `plot_plotly_sankey`

…uirements

j-a-foster

Happy with changes.

…m image

timothy-nunn

The old plot_sankey.py file still exists. If its wrong and not used anymore, should we delete it?

documentation/usage/plotting.md

process/main.py

requirements_dev.txt

chris-ashe · 2025-09-23T08:56:22Z

The old plot_sankey.py file still exists. If its wrong and not used anymore, should we delete it?

Since we cannot output numbers on top of the new Sankey atm then our old Sankey is the only one we can use to put in presentations etc. We should keep for now

Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>

timothy-nunn

Missing images in the docs

timothy-nunn · 2025-09-23T13:24:50Z

documentation/usage/plotting.md

+```
+
+<figure markdown>
+![plotly_sankey_plot](../images/plotly_sankey.png){ width="100%"}


Makes reference to an image that does not exist

Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>

process/io/plot_plotly_sankey.py

Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>

* ✨ Add Sankey diagram plotting for power flow visualization * 🎨 Refactor Sankey diagram plotting: streamline data extraction, enhance node and link color definitions, and improve layout settings * ✨ Add alpha particles back to plasma in Sankey diagram plotting * ✨ Update Sankey diagram: refine alpha particle calculations and add blanket neutron multiplication * ✨ Update HTML output filename in Sankey diagram plotting: strip 'MFILE' and enhance naming convention * 🎨 Refactor node labels in Sankey diagram: simplify formatting and enhance readability * ✨ Update Sankey diagram plotting: replace deprecated plot_sankey with plot_plotly_sankey for improved visualization * 📝 Add interactive Sankey diagram section: introduce usage instructions and example for `plot_plotly_sankey` * ✨ Add kaleido dependency for improved image export in development requirements * 🎨 Refactor main function: remove unused code for saving Sankey diagram image * Make plotly an optional dependency * Update documentation/usage/plotting.md Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com> * Update requirements_dev.txt Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com> * Update process/main.py Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com> * Update process/io/plot_plotly_sankey.py Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com> --------- Co-authored-by: Timothy Nunn <timothy.nunn@ukaea.uk> Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>

chris-ashe self-assigned this Jul 9, 2025

chris-ashe added the Output Files Issues related to the output data files label Jul 9, 2025

chris-ashe force-pushed the plotly_sankey branch from c08cd5b to eee6bb7 Compare July 9, 2025 13:38

chris-ashe added 3 commits September 16, 2025 15:52

✨ Add Sankey diagram plotting for power flow visualization

328b4fc

🎨 Refactor Sankey diagram plotting: streamline data extraction, enhan…

85b2681

…ce node and link color definitions, and improve layout settings

✨ Add alpha particles back to plasma in Sankey diagram plotting

8ccfb67

chris-ashe force-pushed the plotly_sankey branch from 8cf2a5a to 8ccfb67 Compare September 16, 2025 14:53

chris-ashe added 4 commits September 16, 2025 16:24

✨ Update Sankey diagram: refine alpha particle calculations and add b…

a8a315d

…lanket neutron multiplication

✨ Update HTML output filename in Sankey diagram plotting: strip 'MFIL…

b3d4a4b

…E' and enhance naming convention

🎨 Refactor node labels in Sankey diagram: simplify formatting and enh…

314fc6a

…ance readability

✨ Update Sankey diagram plotting: replace deprecated plot_sankey with…

73d1abc

… plot_plotly_sankey for improved visualization

chris-ashe marked this pull request as ready for review September 17, 2025 08:06

chris-ashe requested a review from j-a-foster September 17, 2025 08:06

chris-ashe force-pushed the plotly_sankey branch from 6eabcbb to a1b33fe Compare September 17, 2025 08:18

📝 Add interactive Sankey diagram section: introduce usage instruction…

221e283

…s and example for `plot_plotly_sankey`

chris-ashe force-pushed the plotly_sankey branch from a1b33fe to 221e283 Compare September 17, 2025 08:21

chris-ashe requested a review from timothy-nunn September 17, 2025 08:23

chris-ashe force-pushed the plotly_sankey branch from bd55934 to c595579 Compare September 18, 2025 10:22

✨ Add kaleido dependency for improved image export in development req…

07a2974

…uirements

chris-ashe force-pushed the plotly_sankey branch from c595579 to 07a2974 Compare September 18, 2025 10:28

j-a-foster approved these changes Sep 18, 2025

View reviewed changes

🎨 Refactor main function: remove unused code for saving Sankey diagra…

3e189c5

…m image

chris-ashe force-pushed the plotly_sankey branch from 9248c3c to 3e189c5 Compare September 18, 2025 14:57

Make plotly an optional dependency

a0accde

timothy-nunn requested changes Sep 23, 2025

View reviewed changes

documentation/usage/plotting.md Outdated Show resolved Hide resolved

process/main.py Outdated Show resolved Hide resolved

requirements_dev.txt Outdated Show resolved Hide resolved

chris-ashe and others added 2 commits September 23, 2025 13:23

Update documentation/usage/plotting.md

214e4ff

Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>

Update requirements_dev.txt

4ea2f19

Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>

chris-ashe force-pushed the plotly_sankey branch from 8466d25 to 41c8e06 Compare September 23, 2025 12:50

timothy-nunn requested changes Sep 23, 2025

View reviewed changes

Update process/main.py

cfc8012

Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>

chris-ashe force-pushed the plotly_sankey branch from 3c03198 to cfc8012 Compare September 23, 2025 13:35

timothy-nunn requested changes Sep 23, 2025

View reviewed changes

process/io/plot_plotly_sankey.py Outdated Show resolved Hide resolved

Update process/io/plot_plotly_sankey.py

dc756c9

Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>

timothy-nunn approved these changes Sep 23, 2025

View reviewed changes

timothy-nunn merged commit c154c51 into main Sep 23, 2025
18 checks passed

timothy-nunn deleted the plotly_sankey branch September 23, 2025 14:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

📊 Plotly Sankey #3711

📊 Plotly Sankey #3711

Uh oh!

chris-ashe commented Jul 9, 2025 •

edited

Loading

Uh oh!

codecov-commenter commented Jul 9, 2025 •

edited

Loading

Uh oh!

j-a-foster left a comment

Uh oh!

timothy-nunn left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chris-ashe commented Sep 23, 2025

Uh oh!

timothy-nunn left a comment

Uh oh!

timothy-nunn Sep 23, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

📊 Plotly Sankey #3711

📊 Plotly Sankey #3711

Uh oh!

Conversation

chris-ashe commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation updates

Codebase changes

Checklist

Uh oh!

codecov-commenter commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

j-a-foster left a comment

Choose a reason for hiding this comment

Uh oh!

timothy-nunn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chris-ashe commented Sep 23, 2025

Uh oh!

timothy-nunn left a comment

Choose a reason for hiding this comment

Uh oh!

timothy-nunn Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

chris-ashe commented Jul 9, 2025 •

edited

Loading

codecov-commenter commented Jul 9, 2025 •

edited

Loading