Metadata-Version: 2.1
Name: spectrum-plotter
Version: 0.2.2
Summary: A Python package for creating publication quality plots for neutron / photon / particle spectrum 
Home-page: https://github.com/fusion-energy/spectrum_plotter
Author: The Spectrum Plotter Development Team
Author-email: mail@jshimwell.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

[![N|Python](https://www.python.org/static/community_logos/python-powered-w-100x40.png)](https://www.python.org)

[![CI with install](https://github.com/fusion-energy/spectrum_plotter/actions/workflows/ci_with_install.yml/badge.svg)](https://github.com/fusion-energy/spectrum_plotter/actions/workflows/ci_with_install.yml)

[![Upload Python Package](https://github.com/fusion-energy/spectrum_plotter/actions/workflows/python-publish.yml/badge.svg)](https://github.com/fusion-energy/spectrum_plotter/actions/workflows/python-publish.yml)

# Spectrum Plotter
A Python package for creating standard plots for neutron / photon / particle spectrum

# Installation

```bash
pip install spectrum_plotter
```

# Usage

There are two main functions for plotting spectrum:

```plot_spectrum_from_values()``` - allows users to pass in the tally via a dictionary of tuples where each tuple contains x,y and optionally y_error values as numpy arrays.

```plot_spectrum_from_tally()``` - allows users to pass in an OpenMC tally and plot the result. Units can be automatically scaled,normalised and converted.

:point_right: [Examples](https://github.com/fusion-energy/spectrum_plotter/tree/main/examples)


