Open
Conversation
* related to darshan-hpcgh-808 * adopt [`rich-click`](https://github.com/ewels/rich-click) for the pydarshan summary report CLI, with basic usage and heatmap option blocks * switch to `darshan_summary` as a console script that doesn't require prefixing with `python -m ..`; so new incantation looks like `darshan_summary --log_path treddy_runtime_heatmap_inactive_ranks.darshan` and reports the processing time in seconds automatically * there were two motivations for the above change: 1) simplify the command the user needs to remember 2) I almost always want to know how long the processing took, so report that time by default * this is just a skeleton, and doesn't actually hook in the HEATMAP options to actual changes in the report (yet); one other caveat is that the console script is less friendly for developers that use an "editable install" so you need to use `pip install .` instead of `pip install -e .`, which is a bit annoying, but probably lower priority than user experience concerns/improvements * some TODOs may include: - [ ] remove the old `argparse` CLI interface and hook the new `click`-based CLI interface into the testsuite somehow - [ ] actually implement the heatmap option effects (though this can probably be handled separately, other PRs dealing with that stuff already..) - [ ] discuss the initial set of options we want and how we want to group them into sections - [ ] decide if the extra dependencies are worth it for the CLI improvements (probably?)
ebe36e4 to
425bab7
Compare
13 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
related to ENH: pydarshan via rich-click CLI? #808
adopt
rich-clickfor the pydarshan summary report CLI, with basic usage and heatmap option blocks; example help display:switch to
darshan_summaryas a console script that doesn't require prefixing withpython -m ..; so new incantation looks likedarshan_summary --log_path treddy_runtime_heatmap_inactive_ranks.darshanand reports the processing time in seconds automaticallythere were two motivations for the above change: 1) simplify the command the user needs to remember 2) I almost always want to know how long the processing took, so report that time by default
this is just a skeleton, and doesn't actually hook in the HEATMAP options to actual changes in the report (yet); one other caveat is that the console script is less friendly for developers that use an "editable install" so you need to use
pip install .instead ofpip install -e ., which is a bit annoying, but probably lower priority than user experience concerns/improvementssome TODOs may include:
argparseCLI interface and hook the newclick-based CLI interface into the testsuite somehowhook in the new deps where needed