nrc-cnrc / EGSnrc

Toolkit for Monte Carlo simulation of ionizing radiation — Trousse d'outils logiciels pour la simulation Monte Carlo du rayonnement ionisant
http://nrc-cnrc.github.io/EGSnrc
GNU Affero General Public License v3.0
229 stars 146 forks source link

Documentation in PIRS701 re EEMF_macros is needed #1024

Open dworogers opened 1 year ago

dworogers commented 1 year ago

Malkov's EEMF_macros.mortran for including magnetic and electric field effects are distributed with the system but there is no documentation in PIRS701 about these macros which are faster and easier to use than the previous version. What documentation that is available on the CLRP web pages is out of date (2017) since the EGSnrc core now has the required macro calls (if I understand properly).

ftessier commented 1 year ago

With the blessing of @victorMalkov and @dworogers, we can include the EEMF user guide inside the EGSnrc user manual (PIRS-701). Ensure it is up to date. Encourage users to cite the EEMF paper.

ftessier commented 1 year ago

This is issue #1024. We have reached 1 Kibi-issue! 🎉

ftessier commented 4 days ago

Additionally, the EEMF macros should be included by default across all EGSnrc applications.