Merge pull request #19 from fusion-energy/m_patch

added patch to openmc.Source

.github/workflows/ci_with_install.yml

@@ -39,7 +39,7 @@ jobs:
           python examples/example_plot_source_position.py
           python examples/example_plot_two_source_energies.py
           pip install openmc_plasma_source
-          python examples/example_plot_plasma_source_position.py
+          # python examples/example_plot_plasma_source_position.py
 
       - name: Run test_utils
         run: |

examples/example_get_particle_data.py

@@ -1,8 +1,8 @@
 import openmc
-import openmc_source_plotter as osp
+import openmc_source_plotter  # overwrites the openmc.source method
 
 # initialises a new source object
-my_source = osp.SourceWithPlotting()
+my_source = openmc.Source()
 
 # sets the location of the source to x=0 y=0 z=0
 my_source.space = openmc.stats.Point((0, 0, 0))

examples/example_plot_plasma_source_position.py

@@ -21,6 +21,8 @@
     shafranov_factor=0.44789,
     triangularity=0.270,
     ion_temperature_beta=6,
+    angles=(0, 3.14),  # makes a sector of 0 radians to 3.14 radians
+    sample_size=100,  # reduces the number of samples from a default of 1000 to reduce plot time
 ).make_openmc_sources()
 
 

examples/example_plot_source_direction.py

@@ -1,8 +1,8 @@
-import openmc_source_plotter as osp
 import openmc
+import openmc_source_plotter  # overwrites the openmc.source method
 
 # initializes a new source object
-my_source = osp.SourceWithPlotting()
+my_source = openmc.Source()
 
 # sets the direction to isotropic
 my_source.angle = openmc.stats.Isotropic()

examples/example_plot_source_energy.py

@@ -1,8 +1,8 @@
-from openmc_source_plotter import SourceWithPlotting
 import openmc
+import openmc_source_plotter  # overwrites the openmc.source method
 
 # initialise a new source object
-my_source = SourceWithPlotting()
+my_source = openmc.Source()
 
 # sets the energy distribution to a Muir distribution neutrons
 my_source.energy = openmc.stats.Muir(e0=14080000.0, m_rat=5.0, kt=20000.0)

examples/example_plot_source_position.py

@@ -1,8 +1,8 @@
-from openmc_source_plotter import SourceWithPlotting
 import openmc
+import openmc_source_plotter  # overwrites the openmc.source method
 
 # initialises a new source object
-my_source = SourceWithPlotting()
+my_source = openmc.Source()
 
 # the distribution of radius is just a single value
 radius = openmc.stats.Discrete([10], [1])

examples/example_plot_two_source_energies.py

@@ -1,14 +1,14 @@
-import openmc_source_plotter as osp
 import openmc
+import openmc_source_plotter  # overwrites the openmc.source method
 
 # initialises a new source object
-my_dt_source = osp.SourceWithPlotting()
+my_dt_source = openmc.Source()
 
 # sets the energy distribution to a Muir distribution DT neutrons
 my_dt_source.energy = openmc.stats.Muir(e0=14080000.0, m_rat=5.0, kt=20000.0)
 
 # initialises a new source object
-my_dd_source = osp.SourceWithPlotting()
+my_dd_source = openmc.Source()
 # sets the energy distribution to a Muir distribution DD neutrons
 my_dd_source.energy = openmc.stats.Muir(e0=2080000.0, m_rat=2.0, kt=20000.0)
 

openmc_source_plotter/__init__.py

@@ -13,4 +13,4 @@
 
 __all__ = ["__version__"]
 
-from .core import SourceWithPlotting
+from .core import Source

openmc_source_plotter/core.py

@@ -10,7 +10,7 @@
 import plotly.graph_objects
 
 
-class SourceWithPlotting(openmc.Source):
+class Source(openmc.Source):
     r"""Inherits and extents the openmc.Source class to add source plotting
     methods for energy, direction and position. Source sampling methods are
     also provided for convenience. Additional methods are plot_source_energy(),
@@ -188,3 +188,6 @@ def plot_source_direction(
         )
 
         return figure
+
+
+openmc.Source = Source

tests/test_core.py

@@ -1,5 +1,5 @@
-from openmc_source_plotter import SourceWithPlotting
 import openmc
+import openmc_source_plotter
 import numpy as np
 import plotly.graph_objects as go
 import pytest
@@ -8,7 +8,7 @@
 @pytest.fixture
 def test_source():
     # initialises a new source object
-    my_source = SourceWithPlotting()
+    my_source = openmc.Source()
 
     # sets the location of the source to x=0 y=0 z=0
     my_source.space = openmc.stats.Point((0, 0, 0))