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.

Sign up for GitHub

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

Jump to bottom

Misleading comments in edknrc_template.egsinp input file #1129

Open
dworogers opened this issue May 15, 2024 · 1 comment · May be fixed by #1130
Open

Misleading comments in edknrc_template.egsinp input file #1129

dworogers opened this issue May 15, 2024 · 1 comment · May be fixed by #1130
Assignees
@ftessier @mainegra
Labels
bug documentation
Milestone
Release 2024

Comments

@dworogers
Copy link

dworogers commented May 15, 2024 •
edited by ftessier
Loading

Describe the bug

edknrc_template.egsinp describes source options as

SOURCE NUMBER= 0 # 0,1,2
                 # 0: point source AT origin,   emission along Z-axis
                 # 1: point source AT origin,   isotropically radiating in 4Pi
                 # 2: point source NEAR origin, emission along Z-axis

whereas the manual description is much more precise and less misleading

SOURCE NUMBER 0|1|2
0 ==> Photon moving along Z axis forced to interact at origin
1 ==> Point source at origin, isotropically radiating into 4 Pi
2 ==> Same as 0 but interaction point as in old code

Given that sources 0 and 2 are VERY different from 1, I think their misleading descriptions in the template file should be made the same as the manual.
@dworogers dworogers added the bug label May 15, 2024
@ftessier ftessier changed the title misleading comments in edknrc_template.egsinp Misleading comments in edknrc_template.egsinp input file May 15, 2024
@ftessier ftessier added this to the Release 2024 milestone May 15, 2024
@ftessier ftessier self-assigned this May 15, 2024
ftessier added a commit that referenced this issue May 15, 2024
@ftessier
Fix #1129: update edk template doc to match manual
8f18d13
@ftessier ftessier linked a pull request May 15, 2024 that will close this issue
Fix #1129: update edk template doc to match manual #1130
Open
@ftessier
Copy link
Member

ftessier commented May 15, 2024 •
edited
Loading

@dworogers here is the update, I simply copied what was in the manual to the .egsinp template:
https://github.com/nrc-cnrc/EGSnrc/pull/1130/files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ftessier ftessier

@mainegra mainegra

Labels
bug documentation
Projects
None yet
Milestone
Release 2024
Development

Successfully merging a pull request may close this issue.

Fix #1129: update edk template doc to match manual nrc-cnrc/EGSnrc
3 participants
@ftessier @mainegra @dworogers