docstring fixes

Author: yardasol

examples/msbr/openmc_msbr_model.py

@@ -51,15 +51,17 @@ def parse_arguments():
     -------
     deplete : bool
         Flag indicated whether or not to run a depletion simulation.
-    volume : bool
+    volume_calculation : bool
         Flag indicating whether or not to run a stochastic volume calcuation.
+    entropy : bool
+        Flag indicating whether or not to calculate Shannon entropy.
     """
     parser = argparse.ArgumentParser()
     parser.add_argument('--deplete',
                         type=bool,
                         default=False,
                         help='flag for running depletion')
-    parser.add_argument('--volume',
+    parser.add_argument('--volume_calculation',
                         type=bool,
                         default=False,
                         help='flag for running stochastic volume calculation')
@@ -71,7 +73,7 @@ def parse_arguments():
 
 
     args = parser.parse_args()
-    return bool(args.deplete), bool(args.volume), bool(args.entropy)
+    return bool(args.deplete), bool(args.volume_calculation), bool(args.entropy)
 
 def shared_elem_geometry(elem_type='core',
                          gr_sq_d=4.953,
@@ -384,7 +386,7 @@ def plot_geometry(name,
     return plot
 
 
-deplete, volume, entropy = parse_arguments()
+deplete, volume_calculation, entropy = parse_arguments()
 
 (zone_bounds,
  core_bounds,
@@ -470,7 +472,7 @@ def plot_geometry(name,
                         'range': (800, 1000)}
 
 ll, ur = geo.root_universe.bounding_box
-if volume:
+if volume_calculation:
     msbr_volume_calc = openmc.VolumeCalculation([fuel, moder], int(1e10), ll, ur)
     #msbr_volume_calc.set_trigger(1e-03, 'rel_err')
     settings.volume_calculations = [msbr_volume_calc]

saltproc/openmc_depcode.py

@@ -314,7 +314,7 @@ def _create_mass_percents_dictionary(self, mat, percent_type='ao'):
         mat : openmc.Material
             A material
         percent_type : str
-            Percent type of material,
+            Percent type of material
 
         Returns
         -------

saltproc/simulation.py

@@ -171,7 +171,33 @@ def store_after_repr(self, after_mats, waste_dict, dep_step):
 
     def _fix_nuclide_discrepancy(self, db, earr, iso_idx, iso_wt_frac):
         """Fix discrepancies between nuclide keys present in stored results and
-        nuclides keys stored in results for the current depletion step """
+        nuclides keys stored in results for the current depletion step
+
+        Parameters
+        ----------
+        db : tables.File
+            The SaltProc results database
+        earr : tables.EArray
+            Array storing nuclide material mass compositions from previously
+            completed depletion steps
+        iso_idx : OrderedDict
+            Map of nuclide name to array index
+        iso_wt_frac : list of float
+            List storing nuclide material mass compositions for current
+            depletion step.
+
+        Returns
+        -------
+        earr : tables.EArray
+            Array storing nuclide material mass compositions from
+            previously completed depletion steps with additional
+            rows for nuclides introduces in iso_wt_frac
+        iso_wt_frac : list of float
+            List storing nuclide material mass compositions for current
+            depletion step with additional entries for nuclides not present
+            in the current depletion step that are stored in earr.
+        """
+
         base_nucs= set(earr.attrs.iso_map.keys())
         step_nucs = set(iso_idx.keys())
         forward_difference = base_nucs.difference(step_nucs)
@@ -205,7 +231,38 @@ def _fix_nuclide_discrepancy(self, db, earr, iso_idx, iso_wt_frac):
 
     def _add_missing_nuclides(self, base_nucs, step_nucs, earr, iso_idx, iso_wt_frac):
         """Add missing nuclides to stored results and the results for the
-        current depletion step"""
+        current depletion step
+
+        Parameters
+        ----------
+        base_nucs : set
+            Nuclides present in previous depletion steps
+        step_nucs : set
+            Nuclides present in current depletion step
+        earr : tables.EArray
+            Array storing nuclide material mass compositions from previously
+            completed depletion steps
+        iso_idx : OrderedDict
+            Map of nuclide name to array index
+        iso_wt_frac : list of float
+            List storing nuclide material mass compositions for current
+            depletion step.
+
+        Returns
+        -------
+        combined_nucs : numpy.ndarray
+            Nuclide-code sorted union of base_nucs and step_nucs
+        combined_map : OrderedDict
+            Map of nuclide names to array index
+        combined_earr : numpy.ndarray
+            Array storing nuclide material mass compositions from
+            previously completed depletion steps with additional
+            rows for nuclides introduces in iso_wt_frac
+        combined_step_arr : numpy.ndarray
+            Array storing nuclide material mass compositions for current
+            depletion step with additional entries for nuclides not present
+            in the current depletion step that are stored in earr.
+        """
         combined_nucs = list(base_nucs.union(step_nucs))
         # Sort the nucnames by ZAM
         nuccodes = list(map(self.sim_depcode._convert_name_to_nuccode, combined_nucs))