code inspector comments

Author: shimwell

.circleci/config.yml

@@ -42,7 +42,7 @@ jobs:
 
       # - run:
       #     name: run test_example_neutronics_simulations
-      #     command: 
+      #     command:
       #       pytest tests/test_example_neutronics_simulations.py -v --cov=openmc_dagmc_wrapper --cov-append --cov-report term --cov-report xml
 
 

openmc_dagmc_wrapper/Tally.py

@@ -10,6 +10,12 @@
 
 
 class Tally(openmc.Tally):
+    """
+    Extends the openmc.Tally object to allow a range of standard tally_types.
+    Facilitates standardized combinations of tally openmc.Tally.scores and
+    openmc.Tally.filters to allow convenient application of tallies to
+    specified materials or volumes.
+    """
     def __init__(
         self,
         tally_type,
@@ -308,6 +314,9 @@ def __init__(
         self.plane = plane
         self.mesh_resolution = mesh_resolution
 
+        self.bbox_from_h5 = None
+        self.bounding_box = None
+
         self.create_mesh(bounding_box)
 
         super().__init__(tally_type)

openmc_dagmc_wrapper/utils.py

@@ -186,7 +186,7 @@ def process_results(
             }
             if "std. dev." in data_frame.keys():
                 tally_std_dev = data_frame["std. dev."].sum()
-                results[tally.name]["std. dev."] = tally_std_dev,
+                results[tally.name]["std. dev."] = tally_std_dev
 
         elif tally.name.endswith("heating"):
 

tests/test_neutronics_utils.py

@@ -13,6 +13,8 @@
 
 
 class TestNeutronicsUtilityFunctions(unittest.TestCase):
+    """Tests the neutronics utilities functionality and use cases"""
+
     def setUp(self):
 
         if not Path("tests/v0.0.2.tar.gz").is_file():
@@ -64,25 +66,6 @@ def test_create_material_as_openmc_materials(self):
             assert produced_mat.average_molar_mass == expected_mat.average_molar_mass
             assert produced_mat.nuclides == expected_mat.nuclides
 
-    def test_create_material_as_openmc_materials(self):
-        mats = ["Be", "tungsten", "eurofer", "copper"]
-
-        for mat in mats:
-            # build
-            tag_mat = "mat1"
-            nmm_mat = nmm.Material.from_library(
-                name=mat, material_id=None
-            )
-            expected_mat = nmm_mat.openmc_material
-
-            # run
-            produced_mat = create_material(tag_mat, nmm_mat)
-
-            # test
-            assert produced_mat.density == expected_mat.density
-            assert produced_mat.average_molar_mass == expected_mat.average_molar_mass
-            assert produced_mat.nuclides == expected_mat.nuclides
-
     def test_create_material_wrong_type(self):
         def incorrect_type():
             create_material("mat1", [1, 2, 3])

tests/test_settings.py

@@ -1,11 +1,12 @@
 
 import unittest
 
-import openmc
 import openmc_dagmc_wrapper as odw
 
 
 class TestSettings(unittest.TestCase):
+    """Tests the settings.py file functionality"""
+
     def test_fusion_settings_attributes(self):
         fusion_settings = odw.FusionSettings()
         assert fusion_settings.run_mode == "fixed source"

tests/test_tallies/test_cell_tallies.py

@@ -6,6 +6,7 @@
 
 
 class TestCellTallies(unittest.TestCase):
+    """Tests the CellTallies class functionality"""
 
     def test_name(self):
         my_tally = odw.CellTally('heating', target=1)

tests/test_tallies/test_mesh_tallies.py

@@ -3,12 +3,13 @@
 import urllib.request
 from pathlib import Path
 
-
 import openmc
 import openmc_dagmc_wrapper as odw
 
 
 class TestMeshTallies(unittest.TestCase):
+    """Tests the MeshTallies class functionality"""
+
     def setUp(self):
 
         if not Path("tests/v0.0.2.tar.gz").is_file():
@@ -26,15 +27,15 @@ def test_incorrect_mesh_tally_2d(self):
         """Set a mesh_tally_2d that is not accepted which should raise an
         error"""
         def incorrect_mesh_tally_2d():
-            my_tally = odw.MeshTally2D("coucou", plane="xy")
+            odw.MeshTally2D("coucou", plane="xy")
 
         self.assertRaises(ValueError, incorrect_mesh_tally_2d)
 
     def test_incorrect_mesh_tally_2d_type(self):
         """Set a mesh_tally_2d that is the wrong type which should raise an
         error"""
         def incorrect_mesh_tally_2d_type():
-            my_tally = odw.MeshTally2D(1, plane="xy")
+            odw.MeshTally2D(1, plane="xy")
 
         self.assertRaises(TypeError, incorrect_mesh_tally_2d_type)
 
@@ -43,7 +44,7 @@ def test_incorrect_mesh_tally_3d(self):
         error"""
 
         def incorrect_mesh_tally_3d():
-            my_tally = odw.MeshTally3D("coucou")
+            odw.MeshTally3D("coucou")
 
         self.assertRaises(ValueError, incorrect_mesh_tally_3d)
 
@@ -52,7 +53,7 @@ def test_incorrect_mesh_tally_3d_type(self):
         error"""
 
         def incorrect_mesh_tally_3d_type():
-            my_tally = odw.MeshTally3D(1)
+            odw.MeshTally3D(1)
 
         self.assertRaises(TypeError, incorrect_mesh_tally_3d_type)