examples: added parameter scan

BitterB0NG0 · BitterB0NG0 · commit b92184a87f57 · 2025-07-14T00:38:27.000-07:00
diff --git a/examples/cli_check.py b/examples/cli_check.py
@@ -1,15 +1,15 @@
 """
-Examples for converting INp files using ``Convert``.
+Example converting INp files using ``Convert``.
 """
 
 import pathlib
 
 import pymcnp
 
 # Getting INP path.
-path = pathlib.Path(__file__).parent / 'files' / 'inp' / 'F1.i'
+path = pathlib.Path(__file__).parent / 'files' / 'outp' / 'F1.o'
 
-# Converting.
+# Checking.
 checker = pymcnp.cli.Check(path)
 checker.check()
 
diff --git a/examples/cli_convert.py b/examples/cli_convert.py
@@ -1,5 +1,5 @@
 """
-Examples for converting OUTP files using ``Convert``.
+Example converting OUTP files using ``Convert``.
 """
 
 import pathlib
@@ -9,7 +9,8 @@
 TALLY = '1'
 
 # Reading OUTP.
-outp = pymcnp.Outp.from_file(pathlib.Path(__file__).parent / 'files' / 'outp' / 'F1F8.o')
+path = pathlib.Path(__file__).parent / 'files' / 'outp' / 'F1F8.o'
+outp = pymcnp.Outp.from_file(path)
 
 # Converting.
 converter = pymcnp.cli.Convert(outp)
diff --git a/examples/cli_plot.py b/examples/cli_plot.py
@@ -1,5 +1,5 @@
 """
-Examples for plotting OUTP files using ``Plot``.
+Example plotting OUTP files using ``Plot``.
 """
 
 import pathlib
@@ -11,9 +11,10 @@
 TALLY = '1'
 
 # Reading OUTP.
-outp = pymcnp.Outp.from_file(pathlib.Path(__file__).parent / 'files' / 'outp' / 'F1F8.o')
+path = pathlib.Path(__file__).parent / 'files' / 'outp' / 'F1F8.o'
+outp = pymcnp.Outp.from_file(path)
 
-# Converting.
+# Plotting.
 plotter = pymcnp.cli.Plot(outp)
 plotter.to_show(TALLY)
 matplotlib.pyplot.show()
diff --git a/examples/cli_run.py b/examples/cli_run.py
@@ -1,5 +1,5 @@
 """
-Examples for running INP files using ``Run``.
+Example running INP files using ``Run``.
 """
 
 import pathlib
@@ -9,11 +9,11 @@
 
 # Creating ``Run`` subclass.
 class MyRun(pymcnp.cli.Run):
-    def prehook_file(self, path):
-        print(f'Calling ``prehook_file`` {path}')
+    def prehook_file(self, path, index):
+        print(f'Calling ``prehook_file`` {path} {index}')
 
-    def posthook_file(self, path):
-        print(f'Calling ``posthook_file`` {path}')
+    def posthook_file(self, path, index):
+        print(f'Calling ``posthook_file`` {path} {index}')
 
     def prehook_batch(self, path):
         print(f'Calling ``prehook_batch`` {path}')
@@ -23,9 +23,12 @@ def posthook_batch(self, path):
 
 
 # Reading INP.
-inp0 = pymcnp.Inp.from_file(pathlib.Path(__file__).parent / 'files' / 'inp' / 'F1F8.i')
-inp1 = pymcnp.Inp.from_file(pathlib.Path(__file__).parent / 'files' / 'inp' / 'F1F8.i')
-inp2 = pymcnp.Inp.from_file(pathlib.Path(__file__).parent / 'files' / 'inp' / 'F1.i')
+path0 = pathlib.Path(__file__).parent / 'files' / 'inp' / 'F1F8.i'
+path1 = pathlib.Path(__file__).parent / 'files' / 'inp' / 'F1F8.i'
+path2 = pathlib.Path(__file__).parent / 'files' / 'inp' / 'F1.i'
+inp0 = pymcnp.Inp.from_file(path0)
+inp1 = pymcnp.Inp.from_file(path1)
+inp2 = pymcnp.Inp.from_file(path2)
 
 # Running.
 runner = MyRun([inp0, inp1, inp2], command='echo')
diff --git a/examples/cli_visualize.py b/examples/cli_visualize.py
@@ -1,17 +1,18 @@
 """
-Examples for visualizing INP files using ``Visualize``.
+Example visualizing INP files using ``Visualize``.
 """
 
 import pathlib
 
 import pymcnp
 
 # Reading INP.
-inp = pymcnp.Inp.from_file(pathlib.Path(__file__).parent / 'files' / 'inp' / 'F1F8.i')
+path = pathlib.Path(__file__).parent / 'files' / 'inp' / 'F1F8.i'
+inp = pymcnp.Inp.from_file(path)
 
 # Visualizing surfaces using ``Visualize``.
 visualizer = pymcnp.cli.Visualize(inp)
-visualizer.to_show_surfaces().plot()
+visualizer.to_show_surfaces().show()
 
 # Converting to PDF.
 visualizer.to_pdf_surfaces('F1F8-surfaces.pdf')
diff --git a/examples/create_cell.py b/examples/create_cell.py
@@ -1,5 +1,5 @@
 """
-Examples for creating INP cells.
+Examples creating INP cells.
 """
 
 import pymcnp
diff --git a/examples/create_inp.py b/examples/create_inp.py
@@ -1,5 +1,5 @@
 """
-Examples for creating INP files using ``build``.
+Example creating INP files.
 """
 
 import pymcnp
@@ -77,7 +77,7 @@
 
 # Creating inp.
 inp = pymcnp.Inp(
-    title='Create ``Inp`` Using ``build``\n',
+    title='Create ``Inp``\n',
     cells=[cell_air, cell_shield, cell_lead, cell_world],
     surfaces=[surface_air, surface_shield, surface_lead, surface_world],
     data=[data_air, data_shield, data_lead],
diff --git a/examples/create_material.py b/examples/create_material.py
@@ -1,5 +1,5 @@
 """
-Examples for creating INP materials.
+Examples creating INP materials.
 """
 
 import pymcnp
diff --git a/examples/create_surface.py b/examples/create_surface.py
@@ -1,5 +1,5 @@
 """
-Examples for creating INP surfaces.
+Examples creating INP surfaces.
 """
 
 import pymcnp
diff --git a/examples/files/inp/F1.i b/examples/files/inp/F1.i
@@ -1,24 +1,25 @@
 isotropic neutron source over lunar regolith with two gamma detectors
-c ============================================================================
-c                                    cells                                    
-c ============================================================================
+
+c none
+c cells
+c none
 100 100 -1.54 -1 imp:p,n 1
 200 300 -5.06 -2 imp:p,n 1
 201 200 -5.1 -3 imp:p,n 1
 777 900 -0.000001 1 2 3 -99 imp:p,n 1
 999 0 99 imp:p,n 0
 
-c ============================================================================
-c                                   surfaces                                  
-c ============================================================================
+c none
+c surfaces
+c none
 1 rpp -300 300 -300 300 -150 -50
 2 rcc 50 0 0 0 0 7.62 3.81
 3 rcc -50 0 0 0 0 5.08 2.54
 99 so 600
 
-c ============================================================================
-c                                     data                                    
-c ============================================================================
+c none
+c data
+c none
 m100 013027 -0.1701 020040 -0.131742819 020042 -0.000879273 020044 &
       -0.002834874 026054 -0.00086506 026056 -0.013579592 026057 -0.000313612 &
       008016 -0.45489192 019039 -0.0001865162 019041 -0.0000134604 012024 &
diff --git a/examples/files/inp/inp_A.i b/examples/files/inp/inp_A.i
@@ -0,0 +1,10 @@
+Example Input A
+2 22 -11.34 12 imp:p=1 $ Wall
+
+11 SPH 3 0 0 0.5                       $ Target
+12 BOX 1 -0.5 -0.5 1 0 0 0 1 0 0 0 1 $ Wall
+
+M22 208082 -1 $ Lead
+SDEF PAR=2 POS=0 0 0 ERG=1.0
+NPS 1e5
+F1:P 11
diff --git a/examples/get_cell.py b/examples/get_cell.py
@@ -1,5 +1,5 @@
 """
-Examples for reading INP cells using ``from_mcnp``.
+Example reading INP cells.
 """
 
 import pathlib
@@ -11,6 +11,6 @@
 inp = pymcnp.Inp.from_file(path)
 
 # Reading cell.
-cell = inp.cells[0]
+cell = inp.cells[3]
 
 print(cell)
diff --git a/examples/get_material.py b/examples/get_material.py
@@ -1,5 +1,5 @@
 """
-Examples for reading INP materials using ``from_mcnp``.
+Example reading INP materials.
 """
 
 import pathlib
@@ -11,6 +11,6 @@
 inp = pymcnp.Inp.from_file(path)
 
 # Reading material.
-material = inp.data[0]
+material = inp.data[4]
 
 print(material)
diff --git a/examples/get_surface.py b/examples/get_surface.py
@@ -1,5 +1,5 @@
 """
-Examples for reading INP surfaces using ``from_mcnp``.
+Example reading INP surfaces.
 """
 
 import pathlib
@@ -11,6 +11,6 @@
 inp = pymcnp.Inp.from_file(path)
 
 # Reading surface.
-surface = inp.surfaces[0]
+surface = inp.surfaces[4]
 
 print(surface)
diff --git a/examples/get_tally1.py b/examples/get_tally1.py
@@ -5,11 +5,10 @@
 import pathlib
 
 import pymcnp
-import matplotlib.pyplot as plt
 
 TALLY = '1'
 SURFACE = '2.1'
-ANGLE = '180.0        to  0.90000E+02 degrees'
+ANGLE_FROM = '180.0'
 BIN_WIDTH = 5
 
 # Reading OUTP.
@@ -20,12 +19,6 @@
 tallies = outp.to_dataframe()
 tally = tallies[TALLY]
 tally = tally.loc[tally['surface'] == SURFACE]
-tally = tally.loc[tally['angle'] == ANGLE]
+tally = tally.loc[tally['angle_from'] == ANGLE_FROM]
 
-# Plotting tally.
-plt.figure()
-plt.step(tally['bins'], tally['counts'])
-plt.xlabel('Bins')
-plt.ylabel('Counts')
-plt.title('Type-1 Tally: Bins vs Counts')
-plt.show()
+print(tally)
diff --git a/examples/get_tally2.py b/examples/get_tally2.py
@@ -5,7 +5,6 @@
 import pathlib
 
 import pymcnp
-import matplotlib.pyplot as plt
 
 TALLY = '2'
 SURFACE = '8'
@@ -19,10 +18,4 @@
 tally = tallies[TALLY]
 tally = tally.loc[tally['surface'] == SURFACE]
 
-# Plotting tally.
-plt.figure()
-plt.step(tally['bins'], tally['counts'])
-plt.xlabel('Bins')
-plt.ylabel('Counts')
-plt.title('Type-2 Tally: Bins vs Counts')
-plt.show()
+print(tally)
diff --git a/examples/get_tally4.py b/examples/get_tally4.py
@@ -5,7 +5,6 @@
 import pathlib
 
 import pymcnp
-import matplotlib.pyplot as plt
 
 TALLY = '14'
 CELL = '12'
@@ -17,10 +16,4 @@
 tally = tallies[TALLY]
 tally = tally.loc[tally['cell'] == CELL]
 
-# Plotting tally.
-plt.figure()
-plt.step(tally['bins'], tally['counts'])
-plt.xlabel('Bins')
-plt.ylabel('Counts')
-plt.title('Type-4 Tally: Bins vs Counts')
-plt.show()
+print(tally)
diff --git a/examples/parameter_scan.py b/examples/parameter_scan.py
@@ -0,0 +1,54 @@
+"""
+Example parameter scan.
+"""
+
+import copy
+import shutil
+import pathlib
+
+import pymcnp
+
+
+# Reading INP.
+path_inp = pathlib.Path(__file__).parent / 'files' / 'inp' / 'inp_A.i'
+inp = pymcnp.Inp.from_file(path_inp)
+
+# Scanning.
+inps = []
+for vy in [-2, -1, 0, 1, 2]:
+    inp.surfaces[0].option.vy = vy
+    inps.append(copy.deepcopy(inp))
+
+# Visualizing.
+for inp in inps:
+    visualizer = pymcnp.cli.Visualize(inp)
+    visualization = visualizer.to_show_surfaces()
+    visualization.show()
+
+
+class MyRun(pymcnp.cli.Run):
+    def posthook_file(self, path, index):
+        # Copying OUTP (ECHO used for demo).
+        path_copy = pathlib.Path(__file__).parent / 'files' / 'outp' / 'F1.o'
+        path_outp = path / f'run-{index}.outp'
+        path_outp.open('w').write(path_copy.open('r').read())
+
+        # Reading OUTP.
+        path_outp = path / f'run-{index}.outp'
+        outp = pymcnp.Outp.from_file(path_outp)
+
+        # Plotting.
+        path_pdf = path / '..' / f'run-{index}.pdf'
+        plotter = pymcnp.cli.Plot(outp)
+        plotter.to_pdf('1', path_pdf)
+
+        # Deleting Run.
+        shutil.rmtree(path)
+
+    def posthook_batch(self, path):
+        print('DONE! :)')
+
+
+# Running.
+runner = MyRun(inps, command='echo')
+runner.run('.')
diff --git a/examples/read_inp.py b/examples/read_inp.py
@@ -1,5 +1,5 @@
 """
-Examples for reading INP files.
+Example reading INP files.
 """
 
 import pathlib
diff --git a/examples/read_outp.py b/examples/read_outp.py
@@ -1,5 +1,5 @@
 """
-Examples for reading OUTP files using ``from_file``.
+Example reading OUTP files.
 """
 
 import pathlib
diff --git a/examples/read_ptrac.py b/examples/read_ptrac.py
