Overhall CLI

[je-cook]

Description

Rewrites the CLI to use click and orchestrates all cli modules under the process cli function

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]

Codecov Report

❌ Patch coverage is 19.21296% with 1047 lines in your changes missing coverage. Please review.
✅ Project coverage is 49.19%. Comparing base (893a36c) to head (2c3a9ca).

Files with missing lines	Patch %	Lines
process/core/io/plot/plot_stress_tf.py	0.00%	265 Missing ⚠️
process/core/io/plot/sankey.py	11.60%	160 Missing ⚠️
process/core/io/process_config.py	23.92%	159 Missing ⚠️
process/core/io/plot/plot_scans.py	0.00%	92 Missing ⚠️
process/core/io/plot/cli.py	0.00%	63 Missing ⚠️
process/core/io/plot/costs/costs_bar.py	0.00%	52 Missing ⚠️
process/core/io/in_dat/create.py	0.00%	45 Missing ⚠️
process/core/io/plot/costs/cli.py	0.00%	40 Missing ⚠️
process/core/io/mfile/cli.py	0.00%	30 Missing ⚠️
process/core/io/mfile/comparison.py	21.21%	26 Missing ⚠️
... and 8 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4105      +/-   ##
==========================================
+ Coverage   48.01%   49.19%   +1.17%     
==========================================
  Files         143      146       +3     
  Lines       30164    29707     -457     
==========================================
+ Hits        14482    14613     +131     
+ Misses      15682    15094     -588     

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

Just a few requests.

• Can we add -h as a shortcut for --help as this was a legacy option?
• In some of the plotting options you have to specify -f before the MFILE's while in some the value is positional.
• In the Sankey plot section there is no option to plot the interactive plotly option. Only the old Matplotlib one is there.

[timothy-nunn]

• process
• process --version
• process -i IN.DAT
• process -i IN.DAT --solver my_solver
• process -i IN.DAT --full-output
• process -i large_tokamak_eval.IN.DAT --update-obsolete
• process -i large_tokamak_eval.IN.DAT --mfile my.MFILE.DAT (doesn't work, expected 🐛 --mfile arg does not work as expected #4011)
• process indat
• process indat -f large_tokamak_nof.MFILE.DAT -i large_tokamak_nof.IN.DAT (including -fpi 0, 1, -1)

[je-cook]

Just a few requests.

• Can we add -h as a shortcut for --help as this was a legacy option?

Yeah I can do that

• In some of the plotting options you have to specify -f before the MFILE's while in some the value is positional.

the costs ones are positional (I think thats the only case where its an arg) because you can specify lots of files

• In the Sankey plot section there is no option to plot the interactive plotly option. Only the old Matplotlib one is there.

process plot sankey -fmt html does that I thought?

[timothy-nunn]

Half way through my review and only comments so far are around filenames. Will post them now so they don't get lost over Easter.

[timothy-nunn]

These all seem to be CLI tools, so maybe a more specific filename would be appropriate

[timothy-nunn]

Since this is now called from the command line as summary, would it make sense to call this plot_summary?