Merge pull request #6 from fusion-energy/allowing_movement_of_initial…

…_source.h5 Allowing movement of initial source.h5
fusion-energy · Jan 26, 2022 · 616e4be · 616e4be
2 parents caf9e50 + b4f7f1e
commit 616e4be
Show file tree

Hide file tree

Showing 12 changed files with 390 additions and 210 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,15 @@ A Python package for plotting the locations, directions or energy distributions
 pip install openmc_source_plotter
 ```
 
+temporary fix
+For fixed source sources it is currently necessary to use openmc version 0.11
+and also to point the ```openmc_exec``` path to the openmc executable
+This can be installed with:
+```bash
+conda install -c conda-forge openmc=0.11
+```
+
+
 # Features
 
 The package provides functions to:
@@ -33,15 +42,12 @@ my_source = openmc.Source()
 # sets the energy distribution to a Muir distribution neutrons for DT fusion neutrons
 my_source.energy = openmc.stats.Muir(e0=14080000.0, m_rat=5.0, kt=20000.0)
 
-# makes an initial_source.h5 file with details of the particles
-osp.create_initial_particles(
-    source=my_source,
-    number_of_particles=10000,
-)
-
 # plots the particle energy distribution
-plot = osp.plot_energy_from_initial_source(
-    energy_bins=np.linspace(0, 20e6, 100)
+plot = osp.plot_source_energy(
+    source=my_source,
+    number_of_particles=2000,
+    energy_bins=np.linspace(0, 20e6, 100),
+    openmc_exec="/home/jshim/miniconda3/envs/openmc_0_11_0/bin/openmc",
 )
 
 plot.show()
@@ -59,15 +65,13 @@ my_source = openmc.Source()
 # sets the direction to isotropic
 my_source.angle = openmc.stats.Isotropic()
 
-# makes an initial_source.h5 file with details of the particles
-initial_source_filename = osp.create_initial_particles(
+# plots the particle energy distribution
+plot = osp.plot_source_direction(
     source=my_source,
     number_of_particles=100,
+    openmc_exec="/home/jshim/miniconda3/envs/openmc_0_11_0/bin/openmc",
 )
 
-# plots the particle energy distribution
-plot = osp.plot_direction_from_initial_source(input_filename=initial_source_filename)
-
 plot.show()
 ```
 ![openmc particle source direction plot](https://user-images.githubusercontent.com/8583900/143615706-3b3a8467-0233-42d6-a66c-d536c80a01d8.png)

diff --git a/examples/example_plot_direction_from_initial_source.py b/examples/example_plot_direction_from_initial_source.py
diff --git a/...ot_position_from_initial_plasma_source.py → ...es/example_plot_plasma_source_position.py b/...ot_position_from_initial_plasma_source.py → ...es/example_plot_plasma_source_position.py
@@ -1,6 +1,5 @@
 import openmc_source_plotter as osp
 from openmc_plasma_source import TokamakSource
-import openmc
 
 my_source = TokamakSource(
     elongation=1.557,
@@ -21,14 +20,12 @@
     ion_temperature_beta=6,
 ).make_openmc_sources()
 
-# makes an initial_source.h5 file with details of the particles
-initial_source_filename = osp.create_initial_particles(
+
+# plots the particle energy distribution
+plot = osp.plot_source_position(
     source=my_source,
     number_of_particles=10,
     openmc_exec="/home/jshim/miniconda3/envs/openmc_0_11_0/bin/openmc",
 )
 
-# plots the particle energy distribution
-plot = osp.plot_position_from_initial_source(input_filename=initial_source_filename)
-
 plot.show()
diff --git a/examples/example_plot_source_direction.py b/examples/example_plot_source_direction.py
@@ -0,0 +1,17 @@
+import openmc_source_plotter as osp
+import openmc
+
+# initializes a new source object
+my_source = openmc.Source()
+
+# sets the direction to isotropic
+my_source.angle = openmc.stats.Isotropic()
+
+# plots the particle energy distribution
+plot = osp.plot_source_direction(
+    source=my_source,
+    number_of_particles=100,
+    openmc_exec="/home/jshim/miniconda3/envs/openmc_0_11_0/bin/openmc",
+)
+
+plot.show()
diff --git a/...xample_plot_energy_from_initial_source.py → examples/example_plot_source_energy.py b/...xample_plot_energy_from_initial_source.py → examples/example_plot_source_energy.py
@@ -5,22 +5,15 @@
 # initialises a new source object
 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))
-
 # 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)
 
-# makes an initial_source.h5 file with details of the particles
-initial_source_filename = osp.create_initial_particles(
+# plots the particle energy distribution
+plot = osp.plot_source_energy(
     source=my_source,
     number_of_particles=10000,
+    energy_bins=np.linspace(0, 20e6, 100),
     openmc_exec="/home/jshim/miniconda3/envs/openmc_0_11_0/bin/openmc",
 )
 
-# plots the particle energy distribution
-plot = osp.plot_energy_from_initial_source(
-    energy_bins=np.linspace(0, 20e6, 100), input_filename=initial_source_filename
-)
-
 plot.show()
diff --git a/...mple_plot_position_from_initial_source.py → examples/example_plot_source_position.py b/...mple_plot_position_from_initial_source.py → examples/example_plot_source_position.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()
@@ -19,15 +18,9 @@
     r=radius, phi=angle, z=z_values, origin=(0.0, 0.0, 0.0)
 )
 
-
-# makes an initial_source.h5 file with details of the particles
-initial_source_filename = osp.create_initial_particles(
-    source=my_source,
-    number_of_particles=10,
-    openmc_exec="/home/jshim/miniconda3/envs/openmc_0_11_0/bin/openmc",
-)
-
 # plots the particle energy distribution
-plot = osp.plot_position_from_initial_source(input_filename=initial_source_filename)
+plot = osp.plot_source_position(
+    source=my_source, openmc_exec="/home/jshim/miniconda3/envs/openmc_0_11_0/bin/openmc"
+)
 
 plot.show()
diff --git a/examples/example_plot_two_source_energies.py b/examples/example_plot_two_source_energies.py
@@ -0,0 +1,24 @@
+import openmc_source_plotter as osp
+import openmc
+import numpy as np
+
+# initialises a new source object
+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 = 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)
+
+# plots the particle energy distribution
+plot = osp.plot_source_energy(
+    source=[my_dt_source, my_dd_source],
+    number_of_particles=10000,
+    energy_bins=np.linspace(0, 20e6, 100),
+    openmc_exec="/home/jshim/miniconda3/envs/openmc_0_11_0/bin/openmc",
+)
+
+plot.show()
diff --git a/openmc_source_plotter/__init__.py b/openmc_source_plotter/__init__.py
@@ -1,5 +1,5 @@
-from .core import plot_direction_from_initial_source
-from .core import plot_position_from_initial_source
-from .core import plot_energy_from_initial_source
-from .core import get_particle_data
-from .core import create_initial_particles
+from .utils import get_particle_data
+from .utils import create_initial_particles
+from .core import plot_source_direction
+from .core import plot_source_energy
+from .core import plot_source_position