update docs at commit: Merge pull request #160 from yardasol/cleanup-…

…reprocessing Cleanup reprocessing-related classes and code 86ed1a2
arfc · Aug 11, 2022 · 03b62b6 · 03b62b6
1 parent 3253c25
commit 03b62b6
Show file tree

Hide file tree

Showing 119 changed files with 751 additions and 632 deletions.
diff --git a/master/.buildinfo b/master/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: b0a893b37985341f05fa33eea7806677
+config: 627f503820a2d892ad8655a59befefff
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/master/.doctrees/devguide/contributing.doctree b/master/.doctrees/devguide/contributing.doctree
diff --git a/master/.doctrees/devguide/index.doctree b/master/.doctrees/devguide/index.doctree
diff --git a/master/.doctrees/environment.pickle b/master/.doctrees/environment.pickle
diff --git a/master/.doctrees/examples.doctree b/master/.doctrees/examples.doctree
diff --git a/master/.doctrees/fileformatspec/databasefile.doctree b/master/.doctrees/fileformatspec/databasefile.doctree
diff --git a/master/.doctrees/fileformatspec/index.doctree b/master/.doctrees/fileformatspec/index.doctree
diff --git a/master/.doctrees/fileformatspec/inputfile.doctree b/master/.doctrees/fileformatspec/inputfile.doctree
diff --git a/master/.doctrees/index.doctree b/master/.doctrees/index.doctree
diff --git a/master/.doctrees/installation.doctree b/master/.doctrees/installation.doctree
diff --git a/master/.doctrees/overview.doctree b/master/.doctrees/overview.doctree
diff --git a/master/.doctrees/releasenotes/index.doctree b/master/.doctrees/releasenotes/index.doctree
diff --git a/master/.doctrees/releasenotes/template.doctree b/master/.doctrees/releasenotes/template.doctree
diff --git a/master/.doctrees/releasenotes/v0.3.0.doctree b/master/.doctrees/releasenotes/v0.3.0.doctree
diff --git a/master/.doctrees/releasenotes/v0.4.0.doctree b/master/.doctrees/releasenotes/v0.4.0.doctree
diff --git a/master/.doctrees/releasenotes/v0.5.0.doctree b/master/.doctrees/releasenotes/v0.5.0.doctree
diff --git a/master/.doctrees/src/index.doctree b/master/.doctrees/src/index.doctree
diff --git a/master/.doctrees/src/modules.doctree b/master/.doctrees/src/modules.doctree
diff --git a/master/.doctrees/src/saltproc.app.doctree b/master/.doctrees/src/saltproc.app.doctree
diff --git a/master/.doctrees/src/saltproc.depcode.doctree b/master/.doctrees/src/saltproc.depcode.doctree
diff --git a/master/.doctrees/src/saltproc.doctree b/master/.doctrees/src/saltproc.doctree
diff --git a/master/.doctrees/src/saltproc.materialflow.doctree b/master/.doctrees/src/saltproc.materialflow.doctree
diff --git a/master/.doctrees/src/saltproc.openmc_deplete.doctree b/master/.doctrees/src/saltproc.openmc_deplete.doctree
diff --git a/master/.doctrees/src/saltproc.process.doctree b/master/.doctrees/src/saltproc.process.doctree
diff --git a/master/.doctrees/src/saltproc.reactor.doctree b/master/.doctrees/src/saltproc.reactor.doctree
diff --git a/master/.doctrees/src/saltproc.separator.doctree b/master/.doctrees/src/saltproc.separator.doctree
diff --git a/master/.doctrees/src/saltproc.simulation.doctree b/master/.doctrees/src/saltproc.simulation.doctree
diff --git a/master/.doctrees/src/saltproc.sparger.doctree b/master/.doctrees/src/saltproc.sparger.doctree
diff --git a/master/.doctrees/src/saltproc.tests.doctree b/master/.doctrees/src/saltproc.tests.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_app.doctree b/master/.doctrees/src/saltproc.tests.test_app.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_depcode.doctree b/master/.doctrees/src/saltproc.tests.test_depcode.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_materialflow.doctree b/master/.doctrees/src/saltproc.tests.test_materialflow.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_process.doctree b/master/.doctrees/src/saltproc.tests.test_process.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_separator.doctree b/master/.doctrees/src/saltproc.tests.test_separator.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_simulation.doctree b/master/.doctrees/src/saltproc.tests.test_simulation.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_sparger.doctree b/master/.doctrees/src/saltproc.tests.test_sparger.doctree
diff --git a/master/.doctrees/src/saltproc.version.doctree b/master/.doctrees/src/saltproc.version.doctree
diff --git a/master/_modules/saltproc/app.html b/master/_modules/saltproc/app.html
diff --git a/master/_modules/saltproc/materialflow.html b/master/_modules/saltproc/materialflow.html
@@ -74,14 +74,16 @@
            <div itemprop="articleBody">
 
   <h1>Source code for saltproc.materialflow</h1><div class="highlight"><pre>
-<span></span><span class="kn">from</span> <span class="nn">pyne.material</span> <span class="kn">import</span> <span class="n">Material</span> <span class="k">as</span> <span class="n">pymat</span>
+<span></span><span class="sd">&quot;&quot;&quot;Materialflow module&quot;&quot;&quot;</span>
 <span class="kn">import</span> <span class="nn">copy</span>
 <span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">Counter</span>
 
+<span class="kn">from</span> <span class="nn">pyne.material</span> <span class="kn">import</span> <span class="n">Material</span> <span class="k">as</span> <span class="n">pymat</span>
+
 
 <div class="viewcode-block" id="Materialflow"><a class="viewcode-back" href="../../src/saltproc.materialflow.html#saltproc.materialflow.Materialflow">[docs]</a><span class="k">class</span> <span class="nc">Materialflow</span><span class="p">(</span><span class="n">pymat</span><span class="p">):</span>
-    <span class="sd">&quot;&quot;&quot; Class contains information about burnable material flow. Based on PyNE</span>
-<span class="sd">        Material.</span>
+    <span class="sd">&quot;&quot;&quot; Class contains information about burnable material flow. Based on</span>
+<span class="sd">    :class:`pyne.Material`.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
 <div class="viewcode-block" id="Materialflow.__init__"><a class="viewcode-back" href="../../src/saltproc.materialflow.html#saltproc.materialflow.Materialflow.__init__">[docs]</a>    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
@@ -100,7 +102,8 @@ <h1>Source code for saltproc.materialflow</h1><div class="highlight"><pre>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
-<span class="sd">        PyNE.Material : class</span>
+
+<span class="sd">        :class:`pyne.Material`</span>
 <span class="sd">            PyNE Material parent class containing nuclide vector, density,</span>
 <span class="sd">            mass, atoms_per_molecule, metadata</span>
 <span class="sd">        temp : float</span>

diff --git a/master/_modules/saltproc/process.html b/master/_modules/saltproc/process.html
diff --git a/master/_modules/saltproc/separator.html b/master/_modules/saltproc/separator.html
@@ -74,13 +74,13 @@
            <div itemprop="articleBody">
 
   <h1>Source code for saltproc.separator</h1><div class="highlight"><pre>
-<span></span>
+<span></span><span class="sd">&quot;&quot;&quot;Separator module&quot;&quot;&quot;</span>
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
 <span class="kn">from</span> <span class="nn">saltproc</span> <span class="kn">import</span> <span class="n">Process</span>
 
 
 <div class="viewcode-block" id="Separator"><a class="viewcode-back" href="../../src/saltproc.separator.html#saltproc.separator.Separator">[docs]</a><span class="k">class</span> <span class="nc">Separator</span><span class="p">(</span><span class="n">Process</span><span class="p">):</span>
-    <span class="sd">&quot;&quot;&quot;Class evaluates gas removal efficiency in separator (bubble separator).</span>
+    <span class="sd">&quot;&quot;&quot;Represents a bubble separator.</span>
 
 <span class="sd">    Attributes</span>
 <span class="sd">    ----------</span>
@@ -180,24 +180,27 @@ <h1>Source code for saltproc.separator</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="o">.</span><span class="n">jl</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">q_salt</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">area</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">efficiency</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">eff</span><span class="p">()</span></div>
 
-<div class="viewcode-block" id="Separator.calc_rem_efficiency"><a class="viewcode-back" href="../../src/saltproc.separator.html#saltproc.separator.Separator.calc_rem_efficiency">[docs]</a>    <span class="k">def</span> <span class="nf">calc_rem_efficiency</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">el_name</span><span class="p">):</span>
-        <span class="sd">&quot;&quot;&quot;Overrides the existing method in Process class to provide</span>
-<span class="sd">        efficiency values of target isotopes calculated in eff() function.</span>
+<div class="viewcode-block" id="Separator.calculate_removal_efficiency"><a class="viewcode-back" href="../../src/saltproc.separator.html#saltproc.separator.Separator.calculate_removal_efficiency">[docs]</a>    <span class="k">def</span> <span class="nf">calculate_removal_efficiency</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nuc_name</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Calculate the value of the removal efficiency for a given nuclide</span>
+<span class="sd">        in this process.</span>
+
+<span class="sd">        Overrides the existing method in :class`openmc.process.Process` to</span>
+<span class="sd">        provide efficiency values of target isotopes calculated in the</span>
+<span class="sd">        ``eff()`` function.</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
-<span class="sd">        el_name : str</span>
-<span class="sd">            Name of target element to be removed.</span>
+<span class="sd">        nuc_name : str</span>
+<span class="sd">            Name of target nuclide to be removed.</span>
 
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
 <span class="sd">        efficiency : float</span>
-<span class="sd">            Extraction efficiency for el_name element.</span>
+<span class="sd">            Extraction efficiency for the given nuclide.</span>
 
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="n">efficiency</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">eff</span><span class="p">()[</span><span class="n">el_name</span><span class="p">]</span>
 
-        <span class="k">return</span> <span class="n">efficiency</span></div>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">eff</span><span class="p">()[</span><span class="n">nuc_name</span><span class="p">]</span></div>
 
 <div class="viewcode-block" id="Separator.description"><a class="viewcode-back" href="../../src/saltproc.separator.html#saltproc.separator.Separator.description">[docs]</a>    <span class="k">def</span> <span class="nf">description</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;Class attributes&#39; descriptions for plotting purpose in</span>

diff --git a/master/_modules/saltproc/sparger.html b/master/_modules/saltproc/sparger.html
@@ -74,12 +74,13 @@
            <div itemprop="articleBody">
 
   <h1>Source code for saltproc.sparger</h1><div class="highlight"><pre>
-<span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span></span><span class="sd">&quot;&quot;&quot;Sparger module&quot;&quot;&quot;</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
 <span class="kn">from</span> <span class="nn">saltproc</span> <span class="kn">import</span> <span class="n">Process</span>
 
 
 <div class="viewcode-block" id="Sparger"><a class="viewcode-back" href="../../src/saltproc.sparger.html#saltproc.sparger.Sparger">[docs]</a><span class="k">class</span> <span class="nc">Sparger</span><span class="p">(</span><span class="n">Process</span><span class="p">):</span>
-    <span class="sd">&quot;&quot;&quot;Class evaluates gas removal efficiency in sparger (bubble generator).</span>
+    <span class="sd">&quot;&quot;&quot;Represents a gas sparger/bubble generator.</span>
 
 <span class="sd">    Attributes</span>
 <span class="sd">    ----------</span>
@@ -203,24 +204,26 @@ <h1>Source code for saltproc.sparger</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="o">.</span><span class="n">corr</span> <span class="o">=</span> <span class="n">corr</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">efficiency</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">eff</span><span class="p">()</span></div>
 
-<div class="viewcode-block" id="Sparger.calc_rem_efficiency"><a class="viewcode-back" href="../../src/saltproc.sparger.html#saltproc.sparger.Sparger.calc_rem_efficiency">[docs]</a>    <span class="k">def</span> <span class="nf">calc_rem_efficiency</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">el_name</span><span class="p">):</span>
-        <span class="sd">&quot;&quot;&quot;Overrides the existing method in Process class to provide</span>
-<span class="sd">        efficiency values of target isotopes calculated in eff() function.</span>
+<div class="viewcode-block" id="Sparger.calculate_removal_efficiency"><a class="viewcode-back" href="../../src/saltproc.sparger.html#saltproc.sparger.Sparger.calculate_removal_efficiency">[docs]</a>    <span class="k">def</span> <span class="nf">calculate_removal_efficiency</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nuc_name</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Calculate the value of the removal efficiency for a given nuclide</span>
+<span class="sd">        in this process.</span>
+
+<span class="sd">        Overrides the existing method in :class`openmc.process.Process` to</span>
+<span class="sd">        provide efficiency values of target isotopes calculated in the</span>
+<span class="sd">        ``eff()`` function.</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
-<span class="sd">        el_name : str</span>
-<span class="sd">            Name of target element to be removed.</span>
+<span class="sd">        nuc_name : str</span>
+<span class="sd">            Name of target nuclide to be removed.</span>
 
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
 <span class="sd">        efficiency : float</span>
-<span class="sd">            Extraction efficiency for el_name element.</span>
+<span class="sd">            Extraction efficiency for the given nuclide.</span>
 
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="n">isotope</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">eff</span><span class="p">()[</span><span class="n">el_name</span><span class="p">]</span>
-
-        <span class="k">return</span> <span class="n">isotope</span></div>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">eff</span><span class="p">()[</span><span class="n">nuc_name</span><span class="p">]</span></div>
 
 <div class="viewcode-block" id="Sparger.description"><a class="viewcode-back" href="../../src/saltproc.sparger.html#saltproc.sparger.Sparger.description">[docs]</a>    <span class="k">def</span> <span class="nf">description</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;Class attributes&#39; descriptions for plotting purpose in sensitivity</span>