Generate input documentation from app structs

celeritas-project / celeritas

Celeritas is a new Monte Carlo transport code designed to accelerate scientific discovery in high energy physics by improving detector simulation throughput and energy efficiency using GPUs.

https://celeritas-project.github.io/celeritas/user/index.html

Other

63 stars 34 forks source link

Generate input documentation from app structs #1204

Open sethrj opened 6 months ago

sethrj commented 6 months ago

[ ] Rename app namespace to app_g4 or app_sim or just g4/sim
[ ] Rename Run(ner)?Input.hh to Input.hh and also struct
[ ] Decorate Input structs with more doxygen
[ ] Add */app/Input.hh to file(GLOB _DOXYGEN_SOURCE in doc/CMakeLists.txt
[ ] Add doc/api/app.rst and include the input structs from the applications
[ ] Link to the app "API" from the usage section

sethrj commented 6 months ago

Or potentially generate C++ structs and conversion code from Python data models... 🤔