Merge pull request #15 from fusion-energy/adding_badge_to_readme

added three badges

README.md

@@ -1,3 +1,8 @@
+[![CI with install](https://github.com/fusion-energy/openmc_source_plotter/actions/workflows/ci_with_install.yml/badge.svg)](https://github.com/fusion-energy/openmc_source_plotter/actions/workflows/ci_with_install.yml)
+
+[![Python Flake8 Lint](https://github.com/fusion-energy/openmc_source_plotter/actions/workflows/lint.yaml/badge.svg)](https://github.com/fusion-energy/openmc_source_plotter/actions/workflows/lint.yaml)
+
+[![Upload Python Package](https://github.com/fusion-energy/openmc_source_plotter/actions/workflows/python-publish.yml/badge.svg)](https://github.com/fusion-energy/openmc_source_plotter/actions/workflows/python-publish.yml)
 
 A Python package for plotting the locations, directions or energy distributions of OpenMC sources.
 

examples/example_plot_source_energy.py

@@ -1,6 +1,5 @@
 import openmc_source_plotter as osp
 import openmc
-import numpy as np
 
 # initialises a new source object
 my_source = openmc.Source()

examples/example_plot_source_position.py

@@ -10,7 +10,8 @@
 # the distribution of source z values is just a single value
 z_values = openmc.stats.Discrete([0], [1])
 
-# the distribution of source azimuthal angles values is a uniform distribution between 0 and 2 Pi
+# the distribution of source azimuthal angles
+# values is a uniform distribution between 0 and 2 Pi
 angle = openmc.stats.Uniform(a=0.0, b=2 * 3.14159265359)
 
 # this makes the ring source using the three distributions and a radius

examples/example_plot_two_source_energies.py

@@ -1,6 +1,5 @@
 import openmc_source_plotter as osp
 import openmc
-import numpy as np
 
 # initialises a new source object
 my_dt_source = openmc.Source()

openmc_source_plotter/core.py

@@ -2,7 +2,6 @@
 
 """Provides functions for plotting source information"""
 
-import tempfile
 from typing import List, Union
 
 import numpy as np
@@ -47,12 +46,13 @@ def plot_source_energy(
     """makes a plot of the initial creation postions of an OpenMC source(s)
 
     Args:
-        source: The openmc.Source object or list of openmc.Source objects to plot.
+        source: The openmc.Source object or list of openmc.Source objects to
+            plot.
         n_samples: The number of source samples to obtain.
         prn_seed: The pseudorandom number seed
-        energy_bins: Defaults to 'auto' which uses inbuilt auto binning in Numpy
-            bins can also be manually set by passing in a numpy array of bin
-            edges.
+        energy_bins: Defaults to 'auto' which uses inbuilt auto binning in
+            Numpy bins can also be manually set by passing in a numpy array of
+            bin edges.
     """
 
     figure = go.Figure()
@@ -97,7 +97,8 @@ def plot_source_position(
     """makes a plot of the initial creation postions of an OpenMC source(s)
 
     Args:
-        source: The openmc.Source object or list of openmc.Source objects to plot.
+        source: The openmc.Source object or list of openmc.Source objects to
+            plot.
         n_samples: The number of source samples to obtain.
         prn_seed: The pseudorandom number seed
     """
@@ -127,8 +128,8 @@ def plot_source_position(
                 },
             )
         )
-
-    figure.update_layout(title="Particle production coordinates - coloured by energy")
+    title = "Particle production coordinates coloured by energy"
+    figure.update_layout(title=title)
 
     return figure
 
@@ -141,7 +142,8 @@ def plot_source_direction(
     """makes a plot of the initial creation postions of an OpenMC source(s)
 
     Args:
-        source: The openmc.Source object or list of openmc.Source objects to plot.
+        source: The openmc.Source object or list of openmc.Source objects to
+            plot.
         n_samples: The number of source samples to obtain.
         prn_seed: The pseudorandom number seed
     """

tests/test_core.py

@@ -1,8 +1,6 @@
-from numpy import isin
 import openmc_source_plotter as osp
 import openmc
 import unittest
-from pathlib import Path
 import numpy as np
 import plotly.graph_objects as go