Fix #959: update transport parameters documentation #960
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rtownson
force-pushed
the
update-documentation
branch
from
1b17c5e
to
58ba1b7
Compare
|
Rebased on develop. |
|
I've compile the documentation on this branch and updated the website for the 2023 release. So currently, all of these changes are already live. If we make any changes, just let me know and I will update the website again. |
rtownson
approved these changes
Feb 17, 2023
The documentation in the source code for core EGSnrc parameters options is updated match HEN_HOUSE/src/get_inputs.mortran
ftessier
force-pushed
the
update-documentation
branch
from
58ba1b7
to
b60ce0d
Compare
| @@ -236,27 +234,32 @@ | |||
| to NRC, then use NRC pair production cross-sections | |||
| (in file $HEN_HOUSE/data/pair_nrc1.data). Only | |||
| of interest at low energies, where the NRC cross- | |||
| sections take into account the assymmetry in the | |||
| sections take into account the asymmetry in the | |||
| positron-electron energy distribution. | |||
| [ pair_nrc ] | |||
There was a problem hiding this comment.
Because we all know what happens when you assume assymmetry.
blakewalters
approved these changes
Jun 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the documentation in manuals and in code for the current EGSnrc Monte Carlo parameters and their default options. There was a lot of outdated content scattered throughout. I checked in the code that the defaults correspond to those in the code.
I created many commits to facilitate review. Each one corresponds to one particular option default. The first large one contain the typos and tweaks without any impact on the documentation of defaults.
Note that
dosxyznrchas a different default value for the Boundary crossing algorithm (PRESTA-I, which changes the skin depth as well). I think this should be changed toEXACT, with a note in the documentation to explain how simulations may become faster withPRESTA-I, not the other way around with a justification! The default options should produce the most accurate results possible.The second commit in the chain has to do with an update of defaults in the code (and documentation) for the
IAPRIMparameter. It should be1instead of0. I will move this to its own pull request before merging, to keep the current pull request as documentation only, without functional changes.While at it, I noticed and corrected a number of typos throughout the EGSnrc tree as well.
This fixes #959.