Add case study for SNF-simulations#1042
Open
martinjohndyer wants to merge 2 commits into
Open
Conversation
ns-rse
requested changes
Jun 11, 2026
ns-rse
left a comment
Contributor
There was a problem hiding this comment.
Some suggestions of in-line links to facilitate readers navigating/finding the mentioned items.
Its a matter of personal preference but I tend to prefer wrapping long lines not just in code but also text such as Markdown as it means if there are multiple suggestions it is easier to separate them out and make the changes via the GitHub UI. Also easier when greping a file to narrow things down. I did try adding markdownlint-cli2 as a pre-commit hook to this repository to aid with that but it never gained traction (see #701) but will wrap lines myself.
| --- | ||
| SNF-simulations is a Python software package created to predict the antineutrino emission spectrum from a Spent Nuclear Fuel (SNF) storage facility of any number of dry storage casks with any initial isotopic composition and cooling time after removal from the core. It takes the isotopic composition from FISPIN calculations of nuclear fuel after burn up in a reactor core, and outputs the total antineutrino spectrum, for input into detector simulations. | ||
|
|
||
| Funded for 8 months at 20% FTE as part of the Call for Proposals 2025, the RSE project involved refactoring and modernising the existing codebase, which had been developed by Dr Liz Kneale and her students over several years. The original code was dependent on the ROOT framework making it difficult to install and maintain. The RSE project consolidated and refactored the code, added automated testing and documentation and prepared the package to be released onto PyPI. A web-based dashboard was also developed using the Shiny for Python framework to demonstrate the software's capabilities and provide an accessible interface for users to explore the results. |
Contributor
There was a problem hiding this comment.
Suggested change
| Funded for 8 months at 20% FTE as part of the Call for Proposals 2025, the RSE project involved refactoring and modernising the existing codebase, which had been developed by Dr Liz Kneale and her students over several years. The original code was dependent on the ROOT framework making it difficult to install and maintain. The RSE project consolidated and refactored the code, added automated testing and documentation and prepared the package to be released onto PyPI. A web-based dashboard was also developed using the Shiny for Python framework to demonstrate the software's capabilities and provide an accessible interface for users to explore the results. | |
| Funded for 8 months at 20% FTE as part of the [Call for Proposals 2025](https://rse.shef.ac.uk/blog/2025-09-30-funded-proposals/), the RSE project involved refactoring and modernising the existing codebase, which had been developed by [Dr Liz Kneale](https://sheffield.ac.uk/mps/people/research-staff/liz-kneale) and her students over several years. The original code was dependent on the ROOT framework making it difficult to install and maintain. The RSE project consolidated and refactored the code, removing the dependency on ROOT framework, added automated testing and documentation and packaged the code for release to [PyPI](https://pypi.org/project/snf-simulations/). A web-based dashboard was also developed using the [Shiny for Python](https://shiny.posit.co/py/) framework to demonstrate the software's capabilities and provide an accessible interface for users to explore the results. |
| # JOSS paper and Science paper to be added when published | ||
|
|
||
| --- | ||
| SNF-simulations is a Python software package created to predict the antineutrino emission spectrum from a Spent Nuclear Fuel (SNF) storage facility of any number of dry storage casks with any initial isotopic composition and cooling time after removal from the core. It takes the isotopic composition from FISPIN calculations of nuclear fuel after burn up in a reactor core, and outputs the total antineutrino spectrum, for input into detector simulations. |
Contributor
There was a problem hiding this comment.
Suggested change
| SNF-simulations is a Python software package created to predict the antineutrino emission spectrum from a Spent Nuclear Fuel (SNF) storage facility of any number of dry storage casks with any initial isotopic composition and cooling time after removal from the core. It takes the isotopic composition from FISPIN calculations of nuclear fuel after burn up in a reactor core, and outputs the total antineutrino spectrum, for input into detector simulations. | |
| SNF-simulations is a Python software package created to predict the antineutrino emission spectrum from a Spent Nuclear Fuel (SNF) storage facility of any number of dry storage casks with any initial isotopic composition and cooling time after removal from the core of a nuclear reactor. It takes the isotopic composition from FISPIN calculations of nuclear fuel after burn up in a reactor core, and outputs the total antineutrino spectrum, for input into detector simulations. |
This file contains hidden or 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
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.
Another project for the case study bank. A nice success from the Call for Proposals, with some papers in progress to be added when published. And a very nice quote from Liz!