update docs at commit: Merge pull request arfc#122 from yardasol/fix-…

…v0.4.0-releasenotes Fix v0.4.0 releasenotes + templates c6b3d60
yardasol · Feb 15, 2022 · d2be770 · d2be770
1 parent f658573
commit d2be770
Show file tree

Hide file tree

Showing 144 changed files with 3,094 additions and 793 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: a9ed4fe78b2b985c2f49012844bf440a
+config: e6ea8cf7ba301d0d5d5d9deb7dca4562
 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/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/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.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/index.html b/master/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; Saltproc 0.3.1.dev documentation</title>
+  <title>Overview: module code &mdash; Saltproc 0.4.dev documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -27,7 +27,7 @@
             <a href="../index.html" class="icon icon-home"> Saltproc
           </a>
               <div class="version">
-                0.3.1.dev
+                0.4.dev
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -42,6 +42,8 @@
 <li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../src/index.html">SaltProc API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../releasenotes/index.html">Release Notes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../devguide/index.html">Developer’s Guide</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/arfc/saltproc/blob/master/CITATION.md">How to cite</a></li>
 </ul>
 

diff --git a/master/_modules/saltproc/app.html b/master/_modules/saltproc/app.html
diff --git a/master/_modules/saltproc/depcode.html b/master/_modules/saltproc/depcode.html
diff --git a/master/_modules/saltproc/materialflow.html b/master/_modules/saltproc/materialflow.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>saltproc.materialflow &mdash; Saltproc 0.3.1.dev documentation</title>
+  <title>saltproc.materialflow &mdash; Saltproc 0.4.dev documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -27,7 +27,7 @@
             <a href="../../index.html" class="icon icon-home"> Saltproc
           </a>
               <div class="version">
-                0.3.1.dev
+                0.4.dev
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -42,6 +42,8 @@
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">SaltProc API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../releasenotes/index.html">Release Notes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../devguide/index.html">Developer’s Guide</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/arfc/saltproc/blob/master/CITATION.md">How to cite</a></li>
 </ul>
 

diff --git a/master/_modules/saltproc/process.html b/master/_modules/saltproc/process.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>saltproc.process &mdash; Saltproc 0.3.1.dev documentation</title>
+  <title>saltproc.process &mdash; Saltproc 0.4.dev documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -27,7 +27,7 @@
             <a href="../../index.html" class="icon icon-home"> Saltproc
           </a>
               <div class="version">
-                0.3.1.dev
+                0.4.dev
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -42,6 +42,8 @@
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">SaltProc API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../releasenotes/index.html">Release Notes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../devguide/index.html">Developer’s Guide</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/arfc/saltproc/blob/master/CITATION.md">How to cite</a></li>
 </ul>
 

diff --git a/master/_modules/saltproc/reactor.html b/master/_modules/saltproc/reactor.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>saltproc.reactor &mdash; Saltproc 0.3.1.dev documentation</title>
+  <title>saltproc.reactor &mdash; Saltproc 0.4.dev documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -27,7 +27,7 @@
             <a href="../../index.html" class="icon icon-home"> Saltproc
           </a>
               <div class="version">
-                0.3.1.dev
+                0.4.dev
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -42,6 +42,8 @@
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">SaltProc API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../releasenotes/index.html">Release Notes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../devguide/index.html">Developer’s Guide</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/arfc/saltproc/blob/master/CITATION.md">How to cite</a></li>
 </ul>
 
@@ -79,26 +81,26 @@ <h1>Source code for saltproc.reactor</h1><div class="highlight"><pre>
                  <span class="n">volume</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span>
                  <span class="n">mass_flowrate</span><span class="o">=</span><span class="mf">0.0</span><span class="p">,</span>
                  <span class="n">power_levels</span><span class="o">=</span><span class="p">[</span><span class="mf">0.0</span><span class="p">],</span>
-                 <span class="n">depl_hist</span><span class="o">=</span><span class="p">[</span><span class="mi">1</span><span class="p">]):</span>
+                 <span class="n">dep_step_length_cumulative</span><span class="o">=</span><span class="p">[</span><span class="mi">1</span><span class="p">]):</span>
         <span class="sd">&quot;&quot;&quot;Initializes the class.</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
 <span class="sd">        volume : float</span>
 <span class="sd">            Total volume of the reactor core (:math:`cm^3`).</span>
 <span class="sd">        mass_flowrate : float</span>
-<span class="sd">            Total mass flowrate through reactor (g/s).</span>
+<span class="sd">            Total mass flowrate through reactor core (g/s).</span>
 <span class="sd">        power_levels : array [:math:`N_{steps}` x1]</span>
 <span class="sd">            Normalized power level for each depletion step (W).</span>
-<span class="sd">        depl_hist : array [:math:`N_{steps}` x1]</span>
+<span class="sd">        dep_step_length_cumulative : array [:math:`N_{steps}` x1]</span>
 <span class="sd">            Cumulative depletion time (d).</span>
 
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="c1"># initialize all object attributes</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">volume</span> <span class="o">=</span> <span class="n">volume</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">mass_flowrate</span> <span class="o">=</span> <span class="n">mass_flowrate</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">power_levels</span> <span class="o">=</span> <span class="n">power_levels</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">depl_hist</span> <span class="o">=</span> <span class="n">depl_hist</span></div></div>
+        <span class="bp">self</span><span class="o">.</span><span class="n">dep_step_length_cumulative</span> <span class="o">=</span> <span class="n">dep_step_length_cumulative</span></div></div>
 </pre></div>
 
            </div>

diff --git a/master/_modules/saltproc/separator.html b/master/_modules/saltproc/separator.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>saltproc.separator &mdash; Saltproc 0.3.1.dev documentation</title>
+  <title>saltproc.separator &mdash; Saltproc 0.4.dev documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -27,7 +27,7 @@
             <a href="../../index.html" class="icon icon-home"> Saltproc
           </a>
               <div class="version">
-                0.3.1.dev
+                0.4.dev
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -42,6 +42,8 @@
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">SaltProc API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../releasenotes/index.html">Release Notes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../devguide/index.html">Developer’s Guide</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/arfc/saltproc/blob/master/CITATION.md">How to cite</a></li>
 </ul>