Skip to content

Add case study for SNF-simulations#1042

Open
martinjohndyer wants to merge 2 commits into
masterfrom
martinjohndyer/snf-simulations
Open

Add case study for SNF-simulations#1042
martinjohndyer wants to merge 2 commits into
masterfrom
martinjohndyer/snf-simulations

Conversation

@martinjohndyer

Copy link
Copy Markdown
Member

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!

@ns-rse ns-rse left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants