Deploying to main from @ terrapower/armi@9dc6760 🚀

armi/.apidocs/armi.bookkeeping.historyTracker.html

@@ -140,13 +140,11 @@
 <span id="armi-bookkeeping-historytracker-module"></span><h1>armi.bookkeeping.historyTracker module<a class="headerlink" href="#module-armi.bookkeeping.historyTracker" title="Permalink to this heading"></a></h1>
 <p>The History Tracker is a bookkeeping interface that accesses and reports time-dependent state
 information from the database.</p>
-<p>At the end of a run, these write text files to
-show the histories for various follow-on mechanical analysis,
-fuel performance analysis, etc.</p>
-<p>Other interfaces may find this useful as well, to get an assembly history
-for fuel performance analysis, etc. This is particularly useful in equilibrium runs,
-where the <code class="docutils literal notranslate"><span class="pre">EqHistoryTrackerInterface</span></code> will unravel the full history from a single
-equilibrium cycle.</p>
+<p>At the end of a run, these write text files to show the histories for various follow-on mechanical
+analysis, fuel performance analysis, etc.</p>
+<p>Other interfaces may find this useful as well, to get an assembly history for fuel performance
+analysis, etc. This is particularly useful in equilibrium runs, where the
+<code class="docutils literal notranslate"><span class="pre">EqHistoryTrackerInterface</span></code> will unravel the full history from a single equilibrium cycle.</p>
 <section id="getting-history-information">
 <h2>Getting history information<a class="headerlink" href="#getting-history-information" title="Permalink to this heading"></a></h2>
 <p>Loop over blocks, keys, and timesteps of interest and use commands like this:</p>
@@ -159,20 +157,21 @@ <h3>Using the database-based history trackers<a class="headerlink" href="#using-
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">history</span><span class="o">.</span><span class="n">preloadBlockHistoryVals</span><span class="p">(</span><span class="n">blockNames</span><span class="p">,</span> <span class="n">historyKeys</span><span class="p">,</span> <span class="n">timeSteps</span><span class="p">)</span>
 </pre></div>
 </div>
-<p>This is essential for performance when history information is going to be accessed
-in loops over assemblies or blocks. Reading each param directly from the database
-individually in loops is paralyzingly slow.</p>
+<p>This is essential for performance when history information is going to be accessed in loops over
+assemblies or blocks. Reading each param directly from the database individually in loops is
+paralyzingly slow.</p>
 </section>
 <section id="specifying-parameters-to-add-to-the-eol-history-report">
 <h3>Specifying parameters to add to the EOL history report<a class="headerlink" href="#specifying-parameters-to-add-to-the-eol-history-report" title="Permalink to this heading"></a></h3>
-<p>To add state parameters to the list of things that get their history reported, you need to define an interface
-method called <cite>getHistoryParams</cite>. It should return a list of block parameters that will become available. For example:</p>
+<p>To add state parameters to the list of things that get their history reported, you need to define an
+interface method called <cite>getHistoryParams</cite>. It should return a list of block parameters that will
+become available. For example:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">getHistoryParams</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="k">return</span> <span class="p">[</span><span class="s1">&#39;flux&#39;</span><span class="p">,</span> <span class="s1">&#39;percentBu&#39;</span><span class="p">]</span>
 </pre></div>
 </div>
-<p>When you’d like to access history information, you need to grab the history interface. The history interfaces is
-present by default in your interface stack. To get it, just call:</p>
+<p>When you’d like to access history information, you need to grab the history interface. The history
+interfaces is present by default in your interface stack. To get it, just call:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">history</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getInterface</span><span class="p">(</span><span class="s1">&#39;history&#39;</span><span class="p">)</span>
 </pre></div>
 </div>
@@ -219,11 +218,10 @@ <h3>Specifying blocks and assemblies to track<a class="headerlink" href="#specif
 storing them in memory.</p>
 <div class="admonition warning">
 <p class="admonition-title">Warning</p>
-<p>If the current timestep history is requested and the database has not yet
-been written this timestep, the current value of the requested parameter is
-provided. It is possible that this is not the value that will be written to
-the database during this time step since many interfaces that change
-parameters  may interact between this call and the database write.</p>
+<p>If the current timestep history is requested and the database has not yet been written this
+timestep, the current value of the requested parameter is provided. It is possible that this
+is not the value that will be written to the database during this time step since many
+interfaces that change parameters may interact between this call and the database write.</p>
 </div>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="armi.bookkeeping.historyTracker.HistoryTrackerInterface.name">

armi/.apidocs/armi.cases.suite.html

@@ -140,12 +140,11 @@
 <span id="armi-cases-suite-module"></span><h1>armi.cases.suite module<a class="headerlink" href="#module-armi.cases.suite" title="Permalink to this heading"></a></h1>
 <p>The <code class="docutils literal notranslate"><span class="pre">CaseSuite</span></code> object is responsible for running, and executing a set of user inputs.  Many
 entry points redirect into <code class="docutils literal notranslate"><span class="pre">CaseSuite</span></code> methods, such as <code class="docutils literal notranslate"><span class="pre">clone</span></code>, <code class="docutils literal notranslate"><span class="pre">compare</span></code>, and <code class="docutils literal notranslate"><span class="pre">submit</span></code>.</p>
-<p>Used in conjunction with the <a class="reference internal" href="armi.cases.case.html#armi.cases.case.Case" title="armi.cases.case.Case"><code class="xref py py-class docutils literal notranslate"><span class="pre">Case</span></code></a> object, <code class="docutils literal notranslate"><span class="pre">CaseSuite</span></code> can
-be used to collect a series of cases
-and submit them to a cluster for execution. Furthermore, a <code class="docutils literal notranslate"><span class="pre">CaseSuite</span></code> can be used to gather
-executed cases for post-analysis.</p>
-<p><code class="docutils literal notranslate"><span class="pre">CaseSuite</span></code>s should allow <code class="docutils literal notranslate"><span class="pre">Cases</span></code> to be added from totally separate directories.
-This is useful for plugin-informed testing as well as other things.</p>
+<p>Used in conjunction with the <a class="reference internal" href="armi.cases.case.html#armi.cases.case.Case" title="armi.cases.case.Case"><code class="xref py py-class docutils literal notranslate"><span class="pre">Case</span></code></a> object, <code class="docutils literal notranslate"><span class="pre">CaseSuite</span></code> can be used to
+collect a series of cases and submit them to a cluster for execution. Furthermore, a <code class="docutils literal notranslate"><span class="pre">CaseSuite</span></code>
+can be used to gather executed cases for post-analysis.</p>
+<p><code class="docutils literal notranslate"><span class="pre">CaseSuite</span></code>s should allow <code class="docutils literal notranslate"><span class="pre">Cases</span></code> to be added from totally separate directories. This is
+useful for plugin-informed testing as well as other things.</p>
 <div class="admonition seealso">
 <p class="admonition-title">See also</p>
 <dl class="simple">

armi/.apidocs/armi.html

@@ -1478,6 +1478,27 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
 <li class="toctree-l4"><a class="reference internal" href="armi.utils.reportPlotting.html#armi.utils.reportPlotting.plotAxialProfile"><code class="docutils literal notranslate"><span class="pre">plotAxialProfile()</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="armi.utils.tabulate.html">armi.utils.tabulate module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#usage">Usage</a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#table-headers">Table headers</a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#column-and-headers-alignment">Column and Headers alignment</a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#table-formats">Table formats</a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#number-parsing">Number parsing</a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#column-widths-and-auto-line-wrapping">Column Widths and Auto Line Wrapping</a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.tabulate"><code class="docutils literal notranslate"><span class="pre">tabulate()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.DataRow"><code class="docutils literal notranslate"><span class="pre">DataRow</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.Iterable"><code class="docutils literal notranslate"><span class="pre">Iterable</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.Line"><code class="docutils literal notranslate"><span class="pre">Line</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.Sized"><code class="docutils literal notranslate"><span class="pre">Sized</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.TableFormat"><code class="docutils literal notranslate"><span class="pre">TableFormat</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.TextWrapper"><code class="docutils literal notranslate"><span class="pre">TextWrapper</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.chain"><code class="docutils literal notranslate"><span class="pre">chain</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.namedtuple"><code class="docutils literal notranslate"><span class="pre">namedtuple()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.partial"><code class="docutils literal notranslate"><span class="pre">partial</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.reduce"><code class="docutils literal notranslate"><span class="pre">reduce()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.utils.tabulate.html#armi.utils.tabulate.zip_longest"><code class="docutils literal notranslate"><span class="pre">zip_longest</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l3"><a class="reference internal" href="armi.utils.textProcessors.html">armi.utils.textProcessors module</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="armi.utils.textProcessors.html#armi.utils.textProcessors.SCIENTIFIC_PATTERN"><code class="docutils literal notranslate"><span class="pre">SCIENTIFIC_PATTERN</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="armi.utils.textProcessors.html#armi.utils.textProcessors.FLOATING_PATTERN"><code class="docutils literal notranslate"><span class="pre">FLOATING_PATTERN</span></code></a></li>

armi/.apidocs/armi.reactor.geometry.html

@@ -321,7 +321,7 @@
 yaml and/or the database nicely.</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="armi.reactor.geometry.SymmetryType.VALID_SYMMETRY">
-<span class="sig-name descname"><span class="pre">VALID_SYMMETRY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{(&lt;DomainType.QUARTER_CORE:</span> <span class="pre">4&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.THIRD_CORE:</span> <span class="pre">3&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.SIXTEENTH_CORE:</span> <span class="pre">16&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.EIGHTH_CORE:</span> <span class="pre">8&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.FULL_CORE:</span> <span class="pre">1&gt;,</span> <span class="pre">&lt;BoundaryType.NO_SYMMETRY:</span> <span class="pre">0&gt;,</span> <span class="pre">True),</span> <span class="pre">(&lt;DomainType.QUARTER_CORE:</span> <span class="pre">4&gt;,</span> <span class="pre">&lt;BoundaryType.REFLECTIVE:</span> <span class="pre">2&gt;,</span> <span class="pre">True),</span> <span class="pre">(&lt;DomainType.EIGHTH_CORE:</span> <span class="pre">8&gt;,</span> <span class="pre">&lt;BoundaryType.REFLECTIVE:</span> <span class="pre">2&gt;,</span> <span class="pre">True),</span> <span class="pre">(&lt;DomainType.FULL_CORE:</span> <span class="pre">1&gt;,</span> <span class="pre">&lt;BoundaryType.NO_SYMMETRY:</span> <span class="pre">0&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.QUARTER_CORE:</span> <span class="pre">4&gt;,</span> <span class="pre">&lt;BoundaryType.REFLECTIVE:</span> <span class="pre">2&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.QUARTER_CORE:</span> <span class="pre">4&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">True),</span> <span class="pre">(&lt;DomainType.EIGHTH_CORE:</span> <span class="pre">8&gt;,</span> <span class="pre">&lt;BoundaryType.REFLECTIVE:</span> <span class="pre">2&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.EIGHTH_CORE:</span> <span class="pre">8&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">True),</span> <span class="pre">(&lt;DomainType.SIXTEENTH_CORE:</span> <span class="pre">16&gt;,</span> <span class="pre">&lt;BoundaryType.REFLECTIVE:</span> <span class="pre">2&gt;,</span> <span class="pre">False)}</span></em><a class="headerlink" href="#armi.reactor.geometry.SymmetryType.VALID_SYMMETRY" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">VALID_SYMMETRY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{(&lt;DomainType.SIXTEENTH_CORE:</span> <span class="pre">16&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.FULL_CORE:</span> <span class="pre">1&gt;,</span> <span class="pre">&lt;BoundaryType.NO_SYMMETRY:</span> <span class="pre">0&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.SIXTEENTH_CORE:</span> <span class="pre">16&gt;,</span> <span class="pre">&lt;BoundaryType.REFLECTIVE:</span> <span class="pre">2&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.THIRD_CORE:</span> <span class="pre">3&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.EIGHTH_CORE:</span> <span class="pre">8&gt;,</span> <span class="pre">&lt;BoundaryType.REFLECTIVE:</span> <span class="pre">2&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.FULL_CORE:</span> <span class="pre">1&gt;,</span> <span class="pre">&lt;BoundaryType.NO_SYMMETRY:</span> <span class="pre">0&gt;,</span> <span class="pre">True),</span> <span class="pre">(&lt;DomainType.QUARTER_CORE:</span> <span class="pre">4&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">True),</span> <span class="pre">(&lt;DomainType.EIGHTH_CORE:</span> <span class="pre">8&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">True),</span> <span class="pre">(&lt;DomainType.QUARTER_CORE:</span> <span class="pre">4&gt;,</span> <span class="pre">&lt;BoundaryType.REFLECTIVE:</span> <span class="pre">2&gt;,</span> <span class="pre">True),</span> <span class="pre">(&lt;DomainType.EIGHTH_CORE:</span> <span class="pre">8&gt;,</span> <span class="pre">&lt;BoundaryType.REFLECTIVE:</span> <span class="pre">2&gt;,</span> <span class="pre">True),</span> <span class="pre">(&lt;DomainType.QUARTER_CORE:</span> <span class="pre">4&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.EIGHTH_CORE:</span> <span class="pre">8&gt;,</span> <span class="pre">&lt;BoundaryType.PERIODIC:</span> <span class="pre">1&gt;,</span> <span class="pre">False),</span> <span class="pre">(&lt;DomainType.QUARTER_CORE:</span> <span class="pre">4&gt;,</span> <span class="pre">&lt;BoundaryType.REFLECTIVE:</span> <span class="pre">2&gt;,</span> <span class="pre">False)}</span></em><a class="headerlink" href="#armi.reactor.geometry.SymmetryType.VALID_SYMMETRY" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py method">