Loading Unstable Nuclides from the RIPL-3 Database using the ARMI_RIPL_PATH Environment Variable #74
Conversation
nuclide bases should read in unstable nuclide data from the RIPL-3 data files. These data files are not distributed with the framework, so a user will have to download them separately.
jakehader
changed the title
ARMI_RIPL_PATH Environment Variable
jakehader
changed the title
ARMI_RIPL_PATH Environment Variable
|
I'm excited about this feature. This will help anyone who wants to deal with all fission products. I have the in-line comments above, plus:
|
| `<https://www-nds.iaea.org/RIPL-3/levels/>`_. If the ``ARMI_RIPL_PATH`` environment | ||
| is set to a location containing the full RIPL-3 database, all nuclides will be read | ||
| from there. | ||
There was a problem hiding this comment.
Now that I think about it, some justification as to why we are operating by default with a pruned set of nuclides, and/or why one would want the full data set could be useful. Something to the tune of "For most reactor calculations, it is typical to reduce the dimensionality of depletion by ignoring or lumping together nuclides that aren't important. For other tasks, like detailed decay or activation analysis, a full set of nuclides may be more important."
There was a problem hiding this comment.
Added this to the user_install.rst file and added a link to that documentation here.
|
To explicitly highlight what this feature adds, i've written the nuclides that are processed within |
RIPL-3 decay data files within the `user_install.rst` file. After rending the HTML docs for `nuclideBases` I noticed that the nuclide table was too large for the section, so I removed the MC2-2 and MC2-3 labels from the table. These seem to be implementation details that aren't necessarily required at a high-level to understand the nuclide objects.
|
looks good. in the squash commit msg be sure to note why you eliminated mc2 labels from the big table. Fine by me, just mention why. |
Adding an
ARMI_RIPL_PATHenvironment variable to determine ifnuclide bases should read in unstable nuclide data from the RIPL-3
data files during the
factoryfunction call. These data files are notdistributed with the framework, so a user will have to download them
separately from
https://www-nds.iaea.org/RIPL-3/levels/.