Converting material gamma emission plotting to function

README.md

@@ -14,15 +14,15 @@ pip install openmc_source_plotter
 
 # Features
 
-The package simply extends the default ```openmc.IndependentSourceBase``` and ```openmc.Model``` to provides additional functions that:
+The package provides three plotting functions that can plot source data from openmc objects.
+- ```plot_source_energy```
+- ```plot_source_position```
+- ```plot_source_direction```
+- ```plot_gamma_emission```
+
+Additionally the package provides a convienient method of sampling particles
+- ```sample_initial_particles```
 
-- extract the positions, directions and energy of particles
-- visualise a source with respect to:
-  - direction
-  - energy
-  - position
-
-Or just provide the initial particles with ```sample_initial_particles```
 
 # Example plots
 

examples/example_gamma_spec_plot.py

@@ -1,6 +1,9 @@
 import openmc
 from openmc_source_plotter import plot_gamma_emission
 
+# you will need to install optional dependancies for this example
+# pip install openmc_source_plotter[gammas]
+
 # this path will need changing to point to your chain file
 # openmc.config["chain_file"] = "chain-endf.xml"
 

src/openmc_source_plotter/material.py

@@ -3,7 +3,7 @@
 
 
 def plot_gamma_emission(
-    self,
+    material,
     label_top: int = None,
 ):
     """makes a plot of the gamma energy spectra for a material. The
@@ -26,7 +26,7 @@ def plot_gamma_emission(
         possible_energies_to_label = []
         import lineid_plot
 
-        atoms = self.get_nuclide_atoms()
+        atoms = material.get_nuclide_atoms()
         for nuc, num_atoms in atoms.items():
             dists = []
             probs = []
@@ -47,7 +47,7 @@ def plot_gamma_emission(
 
         probs = []
         en = []
-        energy_dis = self.decay_photon_energy
+        energy_dis = material.get_decay_photon_energy(clip_tolerance=0.0)
         for p in energy_dis.p:
             probs.append(0)
             probs.append(p)
@@ -60,17 +60,17 @@ def plot_gamma_emission(
         # print(probs)
         lineid_plot.plot_line_ids(
             en,
-            # self.decay_photon_energy.x,
+            # material.decay_photon_energy.x,
             probs,
-            # self.decay_photon_energy.p,
+            # material.decay_photon_energy.p,
             energies_to_label,
             labels,
         )
 
     else:
         probs = []
         en = []
-        energy_dis = self.decay_photon_energy
+        energy_dis = material.get_decay_photon_energy(clip_tolerance=0.0)
         for p in energy_dis.p:
             probs.append(0)
             probs.append(p)
@@ -87,6 +87,3 @@ def plot_gamma_emission(
     plt.xlabel("Energy [eV]")
     plt.ylabel("Activity [Bq/s]")
     return plt
-
-
-openmc.Material.plot_gamma_emission = plot_gamma_emission