8000 ✨ Add full output plotting option to `PROCESS` class by chris-ashe · Pull Request #3673 · ukaea/PROCESS · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

✨ Add full output plotting option to PROCESS class #3673

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

Merged
merged 6 commits into from
Jun 11, 2025

Conversation

chris-ashe
Copy link
Collaborator
@chris-ashe chris-ashe commented May 23, 2025

This pull request focuses on improving documentation and enhancing the functionality of the PROCESS tool by introducing a new --full-output flag for automated summary plotting. Key changes include updates to documentation, the addition of the new flag, and the removal of outdated functionality.

Documentation Improvements:

  • Standardized headings in multiple documentation files, replacing <h2> and <h3> tags with Markdown-style headers for consistency (## and ###).
  • Added details about the --full-output flag to the "Running PROCESS" documentation, including examples of its usage and the output it generates.
  • Enhanced the "Plotting" documentation with a note on automatic plot generation using the --full-output flag.

Code Enhancements:

  • Introduced a new --full-output flag in process/main.py to automate the generation of summary plots (e.g., radial build, Sankey diagrams) after a PROCESS run.
  • Updated the post_process method to handle the new --full-output flag, running all relevant plotting scripts (plot_proc, plot_radial_build, plot_sankey).

Code Cleanup:

  • Removed the deprecated --plot argument and its associated logic from process/main.py to streamline the codebase.
  • Updated integration tests to reflect the removal of the --plot argument and to test the --full-output flag instead.

These changes improve both the usability of the PROCESS tool and the clarity of its documentation.

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.

@chris-ashe chris-ashe self-assigned this May 23, 2025
@codecov-commenter
Copy link
codecov-commenter commented May 23, 2025

Codecov Report

Attention: Patch coverage is 16.66667% with 15 lines in your changes missing coverage. Please review.

Project coverage is 37.76%. Comparing base (98ad671) to head (8edaa8f).

Files with missing lines Patch % Lines
process/main.py 18.18% 9 Missing ⚠️
process/io/plot_sankey.py 20.00% 4 Missing ⚠️
process/io/plot_radial_build.py 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3673      +/-   ##
==========================================
+ Coverage   37.63%   37.76%   +0.13%     
==========================================
  Files          87       87              
  Lines       21892    21899       +7     
==========================================
+ Hits         8238     8271      +33     
+ Misses      13654    13628      -26     

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

@chris-ashe chris-ashe requested a review from clmould May 23, 2025 15:38
@chris-ashe chris-ashe changed the title ✨ Add full output plotting option to Process class ✨ Add full output plotting option to PROCESS class May 23, 2025
@chris-ashe chris-ashe marked this pull request as ready for review May 23, 2025 15:38
Copy link
Collaborator
@clmould clmould left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just a couple of minor changes

@chris-ashe chris-ashe force-pushed the full_output_argparse branch from 1c6ff2f to 1f5f9c4 Compare June 11, 2025 10:37
Copy link
Collaborator
@clmould clmould left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@chris-ashe chris-ashe force-pushed the full_output_argparse branch from 1f5f9c4 to 8edaa8f Compare June 11, 2025 12:17
@clmould clmould merged commit 84ea827 into main Jun 11, 2025
18 checks passed
OceanNuclear pushed a commit that referenced this pull request Jul 12, 2025
* ✨ Add full output plotting option to Process class

* 📝 Update documentation for plotting and running PROCESS with full output option

* 📝 Update VS Code documentation and modify integration test to use full output option

* Update documentation/proc-pages/usage/plotting.md

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

* Update documentation/proc-pages/usage/plotting.md

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

* 📝 Refactor output path handling in plotting scripts for clarity and consistency

---------

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>
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.

3 participants
0