Metadata-Version: 2.4
Name: snf_simulations
Version: 2.0.0
Summary: Simulate antineutrino spectra for different compositions of spent nuclear fuel.
Author-email: Liz Kneale <e.kneale@sheffield.ac.uk>, Zuzanna Leliwa <zleliwa1@sheffield.ac.uk>, Abigail Power <apower3@sheffield.ac.uk>, Martin Dyer <martin.dyer@sheffield.ac.uk>
Maintainer-email: Liz Kneale <e.kneale@sheffield.ac.uk>
License-Expression: BSD-3-Clause
Project-URL: homepage, https://github.com/ekneale/SNF-simulations
Project-URL: documentation, https://ekneale.github.io/SNF-simulations
Project-URL: repository, https://github.com/ekneale/SNF-simulations
Keywords: nuclear,antineutrino,spectrum
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pandas>=2.3.3
Requires-Dist: mendeleev>=1.1.0
Provides-Extra: dashboard
Requires-Dist: plotly>=6.7.0; extra == "dashboard"
Requires-Dist: shiny>=1.6.1; extra == "dashboard"
Requires-Dist: shinywidgets>=0.8.1; extra == "dashboard"
Dynamic: license-file

# SNF-simulations
SNF-simulations generates antineutrino spectra that can be used to simulate the antineutrino emission from spent nuclear fuel (SNF).

For more information about what this package does and how to use it, see the [documentation](https://ekneale.github.io/SNF-simulations/index.html).

## Installation
To use, clone the repository then use the package manager [pip](https://pip.pypa.io/en/stable/) to install SNF_simulations.

```bash
pip install snf-simulations
```

If you want to run the dashboard locally, you will need to install the extra dependencies using the following command:

```bash
pip install snf-simulations[dashboard]
```

### Dependencies

SNF-simulations depends on the following packages:

- `numpy`
- `pandas`
- `mendeleev` (for accessing periodic table data)
- `matplotlib` (for plotting with the `snf-sim` demo script)

All dependencies are automatically installed when you install SNF-simulations with pip.

With the `dashboard` option, the following packages are also installed:

- `shiny` (the dashboard is built using the [Shiny framework for Python](https://shiny.posit.co/py/))
- `shinywidgets` (for interactive widgets in the dashboard)
- `plotly` (for interactive plots)
