update docs at commit: Merge pull request #187 from yardasol/flexible…

…-zaid-conventions

Add variable to specify ZAID-format 1af46aa

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: d21131563801f53875fad5ca59da2db7
+config: 37764dc0920cc400648f0387cb59d84e
 tags: 645f666f9bcd5a90fca523b33c5a78b7

master/_sources/fileformatspec/depcode_input.rst.txt

@@ -95,6 +95,22 @@ Serpent-specific properties
   :pattern: 
     ``^(.\\/)*(.*)$``
 
+``zaid_convention``
+~~~~~~~~~~~~~~~~~~~
+
+  :description:
+    ZAID naming convention for nuclide codes. 'serpent': The third digit in ZA for nuclides in isomeric states is 3 (e.g. 47310 for for Ag-110m). 'mcnp': ZA = Z*1000 + A + (300 + 100*m). where m is the mth isomeric state (e.g. 47510 for Ag-110m). 'nndc': Identical to 'mcnp', except Am242m1 is 95242 and Am242 is 95642
+
+
+  :type:
+    ``string``
+
+  :enum:
+    "serpent", "mcnp", "nndc"
+
+  :default:
+    "mcnp"
+
 
 .. _openmc_specific_properties:
 

master/_sources/releasenotes/v0.5.0.rst.txt

@@ -64,6 +64,8 @@ Bug Fixes
 ..
   Describe any bug fixes.
 
+- `Fix bug where Serpent2 material temperatures are hardcoded to 900K in the JEFF 3.1.2 library format. <https://github.com/arfc/saltproc/pull/178>`
+- `Fix bug where using MCNP-style ZAID codes results in an error in various SerpentDepcode functions <https://github.com/arfc/saltproc/issues/187>`
 
 
 
@@ -101,6 +103,7 @@ Python API Changes
   - Chaged the ``-d`` command line argument to ``-s``/``--threads``.
   - (new)  → ``mpi_args``
   - Added default values for certain input parameters
+  - Adds a ``zaid_convention`` input parameter
   - Added depletion settings for OpenMC
   - ``num_depsteps`` → ``n_depletion_steps``
   - ``depcode['template_inputfile_path']`` → ``depcode['template_input_file_path']``
@@ -170,6 +173,7 @@ Python API Changes
     - (new function) →  ``get_neutron_settings()``
     - (new function) →  ``_get_burnable_materials_file()`` 
     - (new function) →  ``_get_burnable_material_card_data()``
+    - (new parameter) →  ``zaid_convention``
 
 
   - ``OpenMCDepcode`` is a ``Depcode`` subclass that interfaces with ``openmc``. This class implements the following functions 

master/fileformatspec/depcode_input.html

@@ -197,6 +197,25 @@ <h2>Generic properties<a class="headerlink" href="#generic-properties" title="Pe
 </dl>
 </div></blockquote>
 </section>
+<section id="zaid-convention">
+<h3><code class="docutils literal notranslate"><span class="pre">zaid_convention</span></code><a class="headerlink" href="#zaid-convention" title="Permalink to this heading">¶</a></h3>
+<blockquote>
+<div><dl class="field-list simple">
+<dt class="field-odd">description</dt>
+<dd class="field-odd"><p>ZAID naming convention for nuclide codes. ‘serpent’: The third digit in ZA for nuclides in isomeric states is 3 (e.g. 47310 for for Ag-110m). ‘mcnp’: ZA = Z*1000 + A + (300 + 100*m). where m is the mth isomeric state (e.g. 47510 for Ag-110m). ‘nndc’: Identical to ‘mcnp’, except Am242m1 is 95242 and Am242 is 95642</p>
+</dd>
+<dt class="field-even">type</dt>
+<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p>
+</dd>
+<dt class="field-odd">enum</dt>
+<dd class="field-odd"><p>“serpent”, “mcnp”, “nndc”</p>
+</dd>
+<dt class="field-even">default</dt>
+<dd class="field-even"><p>“mcnp”</p>
+</dd>
+</dl>
+</div></blockquote>
+</section>
 </section>
 <section id="openmc-specific-properties">
 <span id="id4"></span><h2>OpenMC-specific properties<a class="headerlink" href="#openmc-specific-properties" title="Permalink to this heading">¶</a></h2>

master/releasenotes/v0.5.0.html

@@ -124,6 +124,10 @@ <h2>New Features<a class="headerlink" href="#new-features" title="Permalink to t
 </section>
 <section id="bug-fixes">
 <h2>Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this heading">¶</a></h2>
+<ul class="simple">
+<li><p><cite>Fix bug where Serpent2 material temperatures are hardcoded to 900K in the JEFF 3.1.2 library format. &lt;https://github.com/arfc/saltproc/pull/178&gt;</cite></p></li>
+<li><p><cite>Fix bug where using MCNP-style ZAID codes results in an error in various SerpentDepcode functions &lt;https://github.com/arfc/saltproc/issues/187&gt;</cite></p></li>
+</ul>
 </section>
 <section id="script-changes">
 <h2>Script Changes<a class="headerlink" href="#script-changes" title="Permalink to this heading">¶</a></h2>
@@ -151,6 +155,7 @@ <h2>Python API Changes<a class="headerlink" href="#python-api-changes" title="Pe
 <li><p>Chaged the <code class="docutils literal notranslate"><span class="pre">-d</span></code> command line argument to <code class="docutils literal notranslate"><span class="pre">-s</span></code>/<code class="docutils literal notranslate"><span class="pre">--threads</span></code>.</p></li>
 <li><p>(new)  → <code class="docutils literal notranslate"><span class="pre">mpi_args</span></code></p></li>
 <li><p>Added default values for certain input parameters</p></li>
+<li><p>Adds a <code class="docutils literal notranslate"><span class="pre">zaid_convention</span></code> input parameter</p></li>
 <li><p>Added depletion settings for OpenMC</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">num_depsteps</span></code> → <code class="docutils literal notranslate"><span class="pre">n_depletion_steps</span></code></p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">depcode['template_inputfile_path']</span></code> → <code class="docutils literal notranslate"><span class="pre">depcode['template_input_file_path']</span></code></p></li>
@@ -227,6 +232,7 @@ <h2>Python API Changes<a class="headerlink" href="#python-api-changes" title="Pe
 <li><p>(new function) →  <code class="docutils literal notranslate"><span class="pre">get_neutron_settings()</span></code></p></li>
 <li><p>(new function) →  <code class="docutils literal notranslate"><span class="pre">_get_burnable_materials_file()</span></code></p></li>
 <li><p>(new function) →  <code class="docutils literal notranslate"><span class="pre">_get_burnable_material_card_data()</span></code></p></li>
+<li><p>(new parameter) →  <code class="docutils literal notranslate"><span class="pre">zaid_convention</span></code></p></li>
 </ul>
 </li>
 <li><p><code class="docutils literal notranslate"><span class="pre">OpenMCDepcode</span></code> is a <code class="docutils literal notranslate"><span class="pre">Depcode</span></code> subclass that interfaces with <code class="docutils literal notranslate"><span class="pre">openmc</span></code>. This class implements the following functions

master/src/saltproc.serpent_depcode.html

@@ -79,7 +79,7 @@
 <span id="saltproc-serpent-depcode-module"></span><h1>saltproc.serpent_depcode module<a class="headerlink" href="#module-saltproc.serpent_depcode" title="Permalink to this heading">¶</a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="saltproc.serpent_depcode.SerpentDepcode">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">saltproc.serpent_depcode.</span></span><span class="sig-name descname"><span class="pre">SerpentDepcode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exec_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template_input_file_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">geo_file_paths</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/saltproc/serpent_depcode.html#SerpentDepcode"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#saltproc.serpent_depcode.SerpentDepcode" title="Permalink to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">saltproc.serpent_depcode.</span></span><span class="sig-name descname"><span class="pre">SerpentDepcode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exec_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template_input_file_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">geo_file_paths</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zaid_convention</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/saltproc/serpent_depcode.html#SerpentDepcode"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#saltproc.serpent_depcode.SerpentDepcode" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="saltproc.abc.html#saltproc.abc.Depcode" title="saltproc.abc.Depcode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Depcode</span></code></a></p>
 <p>Interface for running depletion steps in Serpent, as well as obtaining
 depletion step results.</p>
@@ -166,17 +166,25 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="saltproc.serpent_depcode.SerpentDepcode.__init__">
-<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exec_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template_input_file_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">geo_file_paths</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/saltproc/serpent_depcode.html#SerpentDepcode.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#saltproc.serpent_depcode.SerpentDepcode.__init__" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exec_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template_input_file_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">geo_file_paths</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zaid_convention</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/saltproc/serpent_depcode.html#SerpentDepcode.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#saltproc.serpent_depcode.SerpentDepcode.__init__" title="Permalink to this definition">¶</a></dt>
 <dd><p>Initialize a SerpentDepcode object.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>output_path</strong> (<em>str</em>) – Path to results storage directory.</p></li>
 <li><p><strong>exec_path</strong> (<em>str</em>) – Path to Serpent2 executable.</p></li>
 <li><p><strong>template_input_file_path</strong> (<em>str</em>) – Path to user input file for Serpent2</p></li>
-<li><p><strong>geo_file_paths</strong> (<em>str</em><em> or </em><em>list</em><em>, </em><em>optional</em>) – Path to file that contains the reactor geometry.
+<li><p><strong>geo_file_paths</strong> (<em>str</em><em> or </em><em>list</em>) – Path to file that contains the reactor geometry.
 List of <cite>str</cite> if reactivity control by
 switching geometry is <cite>On</cite> or just <cite>str</cite> otherwise.</p></li>
+<li><p><strong>zaid_convention</strong> (<em>str</em>) – <p>ZAID naming convention for nuclide codes.</p>
+<p>’serpent’ - The third digit in ZA for nuclides in isomeric states
+is 3 (e.g. 47310 for for Ag-110m).</p>
+<p>’mcnp’ - ZA = Z*1000 + A + (300 + 100*m). where m is the mth
+isomeric state (e.g. 47510 for Ag-110m)</p>
+<p>’nndc’ - Identical to ‘mcnp’, except Am242m1 is 95242 and Am242
+is 95642</p>
+</p></li>
 </ul>
 </dd>
 </dl>

v0.3.0/.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: 506ba58f66fdd20ddfd2cd28761738e2
+config: d7e0312eb582d9d0d8355a4d642a0fe0
 tags: 645f666f9bcd5a90fca523b33c5a78b7

v0.4.0/.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: da90ea066c2d9e3c2c68aec4f91a8022
+config: a078080d7b12ef11fc8003dfb662444a
 tags: 645f666f9bcd5a90fca523b33c5a78b7