idea: generate MC summary table

[nbassler]

when processing results, one could add an option to provide a prefilled out MC summary table (markdown format) Something like this:

[grzanka]

Thinking loudly which parts of the table can be automatically generated:

• code, version: we have that
• validation: empty
• timing: we have that
• geometry: empty
• source: empty
• physics: empty
• scoring: short summary can be added
• histories: we have it

Caption: empty

[nbassler]

I think even just histories, timing and version would already be a big help so we do not need to find that out manually.

[reviewpad[bot]]

AI-Generated Summary: This issue suggests adding an option to generate a pre-filled Markdown summary table for processing results, making it more convenient and organized for users. An example of the proposed table format is provided as an image.

[nbassler]

bassler@baslup:~/Projects/pymchelper$ PYTHONPATH=. python3 pymchelper/run.py mcsum --many "/home/bassler/Projects/shieldhit/examples/simple/*.bdo"
Item name |  Description | References
|---|---|---|
| Code Version | v1.0.0-5-gc589a089 | |
| Validation | |
| Timing | 3 jobs, 14 seconds total runtime |
| Geometry | |
| Source | |
| Physics | |
| Scoring | |
|\# histories | 2889 | |
Table caption: Summary of Monte Carlo simulations parameters in AAPM TG268 format.
[See Sechopoulos et al. (2018), https://doi.org/10.1002/mp.12702.]
bassler@baslup:~/Projects/pymchelper$ 

[reviewpad[bot]]

AI-Generated Summary: This issue suggests adding an option to generate a pre-filled markdown summary table for processed results, making it easier for users to view and understand the data.