Skip to content
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

idea: generate MC summary table #626

Open
nbassler opened this issue Apr 3, 2023 · 5 comments · May be fixed by #634
Open

idea: generate MC summary table #626

nbassler opened this issue Apr 3, 2023 · 5 comments · May be fixed by #634

Comments

@nbassler
Copy link
Member

nbassler commented Apr 3, 2023

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

image

@grzanka
Copy link
Contributor

grzanka commented Apr 5, 2023

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
Copy link
Member Author

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
Copy link
Contributor

reviewpad bot commented Apr 19, 2023

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
Copy link
Member Author

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$ 

image

@reviewpad
Copy link
Contributor

reviewpad bot commented Apr 19, 2023

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.

@nbassler nbassler linked a pull request Apr 19, 2023 that will close this issue
@nbassler nbassler linked a pull request Apr 19, 2023 that will close this issue
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 a pull request may close this issue.

2 participants