Skip to content

Sankey diagram example#803

Merged
Andy-Grigg merged 3 commits into
mainfrom
doc/sustainability-sankey-diagram
May 30, 2025
Merged

Sankey diagram example#803
Andy-Grigg merged 3 commits into
mainfrom
doc/sustainability-sankey-diagram

Conversation

@Andy-Grigg
Copy link
Copy Markdown
Collaborator

@Andy-Grigg Andy-Grigg commented May 29, 2025

Closes #736

Add an example of a Sankey diagram. This is still somewhat limited, there is no in-use, circularity, or end-of-life aspect to the analytics, but nevertheless this shows the principle of how the total embodied energy of a product is created based on the materials, processes, and transportation.

This could also be done as part of the full hierarchical BoM. I might have a look to see how the visualization works there, but I feel like the data would be too complex to make sense of.

I also thought about adding this as a standalone example. I don't think it warrants this on its own, but possibly the graphing could all be broken out into individual examples. This probably wouldn't be too bad to do.

@Andy-Grigg Andy-Grigg requested a review from da1910 May 29, 2025 21:12
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 29, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented May 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.88%. Comparing base (01e5cbb) to head (8d00059).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #803      +/-   ##
==========================================
+ Coverage   97.53%   97.88%   +0.35%     
==========================================
  Files          28       28              
  Lines        3124     3124              
==========================================
+ Hits         3047     3058      +11     
+ Misses         77       66      -11     
Flag Coverage Δ
integration-ubuntu-latest-TEST_SERVER_24R2_URL 81.37% <ø> (?)
integration-ubuntu-latest-TEST_SERVER_25R1_URL 81.37% <ø> (?)
integration-ubuntu-latest-TEST_SERVER_25R2_URL 87.54% <ø> (?)
integration-ubuntu-latest-TEST_SERVER_DEV_URL 87.54% <ø> (?)
integration-windows-latest-TEST_SERVER_24R2_URL 81.37% <ø> (?)
integration-windows-latest-TEST_SERVER_25R1_URL 81.37% <ø> (?)
integration-windows-latest-TEST_SERVER_25R2_URL 87.54% <ø> (?)
integration-windows-latest-TEST_SERVER_DEV_URL 87.54% <ø> (?)
unittests 97.53% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@da1910
Copy link
Copy Markdown
Collaborator

da1910 commented May 30, 2025

Looks fine in terms of the code and it renders the code cells correctly - nothing is showing up for the plots for me locally, just a warning that ploty objects cannot be displayed. I suspect this is not a problem with this PR

@Andy-Grigg
Copy link
Copy Markdown
Collaborator Author

I have spiked splitting the Sustainability Summary example into separate notebooks for the summary, materials and processes, transports, and full hierarchy on a separate branch. I'll try and finish that off today, but it will be a separate branch and PR.

@Andy-Grigg Andy-Grigg added this pull request to the merge queue May 30, 2025
Merged via the queue into main with commit d9652ef May 30, 2025
54 checks passed
@Andy-Grigg Andy-Grigg deleted the doc/sustainability-sankey-diagram branch May 30, 2025 12:49
Andy-Grigg added a commit that referenced this pull request Jun 5, 2025
Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
Andy-Grigg added a commit that referenced this pull request Jun 5, 2025
Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Example proposal: Sankey diagram

3 participants