-
Notifications
You must be signed in to change notification settings - Fork 13
✨ 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
Conversation
Codecov ReportAttention: Patch coverage is
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. 🚀 New features to boost your workflow:
|
PROCESS
class
There was a problem hiding this 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
1c6ff2f
to
1f5f9c4
Compare
There was a problem hiding this 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
Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>
Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>
1f5f9c4
to
8edaa8f
Compare
* ✨ 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>
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:
<h2>
and<h3>
tags with Markdown-style headers for consistency (##
and###
).--full-output
flag to the "Running PROCESS" documentation, including examples of its usage and the output it generates.--full-output
flag.Code Enhancements:
--full-output
flag inprocess/main.py
to automate the generation of summary plots (e.g., radial build, Sankey diagrams) after aPROCESS
run.post_process
method to handle the new--full-output
flag, running all relevant plotting scripts (plot_proc
,plot_radial_build
,plot_sankey
).Code Cleanup:
--plot
argument and its associated logic fromprocess/main.py
to streamline the codebase.--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: