update docs at commit: Merge pull request arfc#165 from yardasol/open…

…mc-msbr-model

OpenMC MSBR model and data 6bac510

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: e8de18a716b168d29b4bd469ec16a240
+config: c122b6801766bd27c7875cfc36b49932
 tags: 645f666f9bcd5a90fca523b33c5a78b7

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

@@ -54,6 +54,7 @@ New Features
   Describe any new features to the code.
 
 - ``openmc`` support via `DepcodeOpenMC`
+- OpenMC compatible MSBR model.
 
 
 
@@ -81,7 +82,9 @@ Script Changes
   - Add ``SERPENT_DATA`` and ``SERPENT_ACELIB`` variables to ``.bashrc``
 
 - A new script, ``scripts/ci/openmc-xs.bash``, that downloads the OpenMC HDF5 cross section library.
-
+- A new script, ``download_endfb71.bash``, that downloads the ENDF/B 7.1 cross section library -- including thermal scattering, decay, and fission yield data -- in ACE format.
+- A new script, ``process_endfb71_to_openmc.bash``, that converts the library created by ``download_endfb71.bash`` into an OpenMC-usable HDF5 format. Requires OpenMC to be installed from source to use.
+- A new script ``openmc_msbr_model.py``, that creates an OpenMC-usable MSBR model based on the Serpent MSBR model.
 
 
 Python API Changes
@@ -108,27 +111,60 @@ Python API Changes
    longer be initialized by the user during object creation.
 
 
-- New/changed classes and methods:
+- New/changed classes, methods, and attributes:
 
   - ``Depcode``
 
+    - Add `output_path` parameter.
     - ``template_inputfile_path`` → ``template_input_file_path``
-    - Changed `iter_inputfile` and `iter_matfile` to be attributes instead of parameters
+    - Removed default values for `geo_files`
+    - Changed `iter_inputfile`, `iter_matfile` to be attributes instead of parameters
+    - Changed `npop`, `active_cycles`, `inactive_cycles` to be attributes instead of parameters
+    - ``read_depcode_info()`` → ``read_step_metadata()``
+    - ``sim_info`` → ``step_metadata``
+    - ``read_depcode_step_param()`` → ``read_neutronics_parameters()``
+    - ``param`` → ``neutronics_parameters``
+    - ``read_dep_comp()`` → ``read_depleted_materials()``
+    - ``run_depcode()`` → ``run_depletion_step()``
+    - ``write_mat_file()`` → ``update_depletable_materials()``
+    - ``write_depcode_input()`` →  ``write_runtime_input()``
+    - ``iter_inputfile``  →  ``runtime_inputfile``
+    - ``iter_matfile``  →  ``runtime_matfile``
 
   - ``DepcodeSerpent`` → ``SerpentDepcode``
 
+    - Add `output_path` parameter.
     - ``template_inputfile_path`` → ``template_input_file_path``
-    - Changed `iter_inputfile` and `iter_matfile` to be attributes instead of parameters
+    - Removed default values for `exec_path`, `template_input_file_path`, `geo_files`
+    - Changed `iter_inputfile`, `iter_matfile` to be attributes instead of parameters
+    - Changed `npop`, `active_cycles`, `inactive_cycles` to be attributes instead of parameters
+    - ``read_depcode_info()`` → ``read_depletion_step_metadata()``
+    - ``sim_info`` → ``step_metadata``
+    - ``read_depcode_step_param()`` → ``read_neutronics_parameters()``
+    - ``param`` → ``neutronics_parameters``
+    - ``read_dep_comp()`` → ``read_depleted_materials()``
+    - ``create_nuclide_name_map_zam_to_serpent()`` → ``map_nuclide_code_zam_to_serpent()``
+    - ``run_depcode()`` → ``run_depletion_step()``
+    - ``write_mat_file()`` → ``update_depletable_materials()``
+    - ``get_nuc_name()`` →  ``convert_nuclide_code_to_name()``
+    - ``convert_nuclide_name_serpent_to_zam()`` → ``convert_nuclide_code_to_zam()`` 
+    - ``change_sim_par()`` →  (deleted)
+    -  (new function) →  ``get_neutron_settings()``
+    - ``create_iter_matfile()`` → ``create_runtime_matfile()``
+    - ``replace_burnup_parameters()`` → ``set_power_load()``
+    - ``write_depcode_input()`` →  ``write_runtime_input()``
+    - ``iter_inputfile``  →  ``runtime_inputfile``
+    - ``iter_matfile``  →  ``runtime_matfile``
 
 
   - ``OpenMCDepcode`` is a ``Depcode`` subclass that interfaces with ``openmc``. This class implements the following functions 
-
-    - ``run_depcode()``
+    - ``run_depletion_step()``
     - ``switch_to_next_geometry()``
-    - ``write_depcode_input()``
+    - ``write_runtime_input()``
     - ``write_depletion_settings()``
     - ``write_saltproc_openmc_tallies()``
 
+
   - ``app.py``
 
     - ``reprocessing()`` → ``reprocess_materials()``

master/fileformatspec/inputfile.html

@@ -145,7 +145,7 @@ <h2>SaltProc input file schema<a class="headerlink" href="#saltproc-input-file-s
 <td colspan="5"><p><em>string</em></p></td>
 </tr>
 <tr class="row-even"><td><p>pattern</p></td>
-<td colspan="5"><p>^\.\/(.*)$</p></td>
+<td colspan="5"><p>^(.\/)*(.*)$</p></td>
 </tr>
 <tr class="row-odd"><td rowspan="2"><ul class="simple">
 <li><p>num_depsteps</p></li>
@@ -156,7 +156,7 @@ <h2>SaltProc input file schema<a class="headerlink" href="#saltproc-input-file-s
 <tr class="row-even"><td><p>type</p></td>
 <td colspan="5"><p><em>number</em></p></td>
 </tr>
-<tr class="row-odd"><td rowspan="47"><ul class="simple">
+<tr class="row-odd"><td rowspan="49"><ul class="simple">
 <li><p><strong>depcode</strong></p></li>
 </ul>
 </td>
@@ -194,75 +194,51 @@ <h2>SaltProc input file schema<a class="headerlink" href="#saltproc-input-file-s
 </td>
 <td colspan="5"><p>Path(s) to user’s template depletion code input file(s) with reactor model</p></td>
 </tr>
-<tr class="row-even"><td rowspan="3"><ul class="simple">
-<li><p><strong>npop</strong></p></li>
-</ul>
-</td>
-<td colspan="5"><p>Number of neutrons per generation</p></td>
-</tr>
-<tr class="row-odd"><td><p>type</p></td>
-<td colspan="4"><p><em>number</em></p></td>
-</tr>
-<tr class="row-even"><td><p>minimum</p></td>
-<td colspan="4"><p>0</p></td>
-</tr>
-<tr class="row-odd"><td rowspan="3"><ul class="simple">
-<li><p><strong>active_cycles</strong></p></li>
-</ul>
-</td>
-<td colspan="5"><p>number of active generations</p></td>
-</tr>
-<tr class="row-even"><td><p>type</p></td>
-<td colspan="4"><p><em>number</em></p></td>
-</tr>
-<tr class="row-odd"><td><p>minimum</p></td>
-<td colspan="4"><p>0</p></td>
-</tr>
-<tr class="row-even"><td rowspan="3"><ul class="simple">
-<li><p><strong>inactive_cycles</strong></p></li>
-</ul>
-</td>
-<td colspan="5"><p>Number of inactive generations</p></td>
-</tr>
-<tr class="row-odd"><td><p>type</p></td>
-<td colspan="4"><p><em>number</em></p></td>
-</tr>
-<tr class="row-even"><td><p>minimum</p></td>
-<td colspan="4"><p>0</p></td>
-</tr>
-<tr class="row-odd"><td rowspan="5"><ul class="simple">
+<tr class="row-even"><td rowspan="5"><ul class="simple">
 <li><p><strong>geo_file_paths</strong></p></li>
 </ul>
 </td>
 <td colspan="5"><p>Path(s) to geometry file(s) to switch to in depletion code runs</p></td>
 </tr>
-<tr class="row-even"><td><p>type</p></td>
+<tr class="row-odd"><td><p>type</p></td>
 <td colspan="4"><p><em>array</em></p></td>
 </tr>
-<tr class="row-odd"><td><p>items</p></td>
+<tr class="row-even"><td><p>items</p></td>
 <td><p>type</p></td>
 <td colspan="3"><p><em>string</em></p></td>
 </tr>
-<tr class="row-even"><td><p>minItems</p></td>
+<tr class="row-odd"><td><p>minItems</p></td>
 <td colspan="4"><p>1</p></td>
 </tr>
-<tr class="row-odd"><td><p>uniqueItems</p></td>
+<tr class="row-even"><td><p>uniqueItems</p></td>
 <td colspan="4"><p>False</p></td>
 </tr>
-<tr class="row-even"><td rowspan="24"><p>allOf</p></td>
+<tr class="row-odd"><td rowspan="35"><p>allOf</p></td>
 <td rowspan="2"><p>if</p></td>
 <td colspan="4"><p>properties</p></td>
 </tr>
-<tr class="row-odd"><td><ul class="simple">
+<tr class="row-even"><td><ul class="simple">
 <li><p>codename</p></li>
 </ul>
 </td>
 <td><p>const</p></td>
 <td colspan="2"><p>serpent</p></td>
 </tr>
-<tr class="row-even"><td rowspan="4"><p>then</p></td>
+<tr class="row-odd"><td rowspan="7"><p>then</p></td>
 <td colspan="4"><p>properties</p></td>
 </tr>
+<tr class="row-even"><td rowspan="3"><ul class="simple">
+<li><p>exec_path</p></li>
+</ul>
+</td>
+<td colspan="3"><p>Path to Serpent executable</p></td>
+</tr>
+<tr class="row-odd"><td><p>type</p></td>
+<td colspan="2"><p><em>string</em></p></td>
+</tr>
+<tr class="row-even"><td><p>default</p></td>
+<td colspan="2"><p>sss2</p></td>
+</tr>
 <tr class="row-odd"><td rowspan="3"><ul class="simple">
 <li><p>template_input_file_path</p></li>
 </ul>
@@ -273,7 +249,7 @@ <h2>SaltProc input file schema<a class="headerlink" href="#saltproc-input-file-s
 <td colspan="2"><p><em>string</em></p></td>
 </tr>
 <tr class="row-odd"><td><p>pattern</p></td>
-<td colspan="2"><p>^\.\/(.*)$</p></td>
+<td colspan="2"><p>^(.\/)*(.*)$</p></td>
 </tr>
 <tr class="row-even"><td rowspan="2"><p>if</p></td>
 <td colspan="4"><p>properties</p></td>
@@ -285,33 +261,48 @@ <h2>SaltProc input file schema<a class="headerlink" href="#saltproc-input-file-s
 <td><p>const</p></td>
 <td colspan="2"><p>openmc</p></td>
 </tr>
-<tr class="row-even"><td rowspan="16"><p>then</p></td>
+<tr class="row-even"><td rowspan="24"><p>then</p></td>
 <td colspan="4"><p>properties</p></td>
 </tr>
-<tr class="row-odd"><td rowspan="15"><ul class="simple">
+<tr class="row-odd"><td rowspan="3"><ul class="simple">
+<li><p>exec_path</p></li>
+</ul>
+</td>
+<td colspan="3"><p>Path to OpenMC depletion script</p></td>
+</tr>
+<tr class="row-even"><td><p>type</p></td>
+<td colspan="2"><p><em>string</em></p></td>
+</tr>
+<tr class="row-odd"><td><p>default</p></td>
+<td colspan="2"><p>openmc_deplete.py</p></td>
+</tr>
+<tr class="row-even"><td rowspan="14"><ul class="simple">
 <li><p>template_input_file_path</p></li>
 </ul>
 </td>
 <td colspan="3"><p>Paths to OpenMC template input files</p></td>
 </tr>
-<tr class="row-even"><td><p>type</p></td>
+<tr class="row-odd"><td><p>type</p></td>
 <td colspan="2"><p><em>object</em></p></td>
 </tr>
-<tr class="row-odd"><td colspan="3"><p>properties</p></td>
+<tr class="row-even"><td colspan="3"><p>properties</p></td>
 </tr>
-<tr class="row-even"><td rowspan="3"><ul class="simple">
+<tr class="row-odd"><td rowspan="4"><ul class="simple">
 <li><p><strong>settings</strong></p></li>
 </ul>
 </td>
 <td colspan="2"><p>OpenMC settings file</p></td>
 </tr>
-<tr class="row-odd"><td><p>type</p></td>
+<tr class="row-even"><td><p>type</p></td>
 <td><p><em>string</em></p></td>
 </tr>
-<tr class="row-even"><td><p>pattern</p></td>
-<td><p>^\.\/(.*)\.xml$</p></td>
+<tr class="row-odd"><td><p>pattern</p></td>
+<td><p>^(.\/)*(.*)\.xml$</p></td>
 </tr>
-<tr class="row-odd"><td rowspan="3"><ul class="simple">
+<tr class="row-even"><td><p>default</p></td>
+<td><p>settings.xml</p></td>
+</tr>
+<tr class="row-odd"><td rowspan="4"><ul class="simple">
 <li><p><strong>materials</strong></p></li>
 </ul>
 </td>
@@ -321,19 +312,10 @@ <h2>SaltProc input file schema<a class="headerlink" href="#saltproc-input-file-s
 <td><p><em>string</em></p></td>
 </tr>
 <tr class="row-odd"><td><p>pattern</p></td>
-<td><p>^\.\/(.*)\.xml$</p></td>
+<td><p>^(.\/)*(.*)\.xml$</p></td>
 </tr>
-<tr class="row-even"><td rowspan="3"><ul class="simple">
-<li><p>plots</p></li>
-</ul>
-</td>
-<td colspan="2"><p>OpenMC plots file (optional)</p></td>
-</tr>
-<tr class="row-odd"><td><p>type</p></td>
-<td><p><em>string</em></p></td>
-</tr>
-<tr class="row-even"><td><p>pattern</p></td>
-<td><p>^\.\/(.*)\.xml$</p></td>
+<tr class="row-even"><td><p>default</p></td>
+<td><p>materials.xml</p></td>
 </tr>
 <tr class="row-odd"><td rowspan="3"><ul class="simple">
 <li><p><strong>chain_file</strong></p></li>
@@ -345,7 +327,29 @@ <h2>SaltProc input file schema<a class="headerlink" href="#saltproc-input-file-s
 <td><p><em>string</em></p></td>
 </tr>
 <tr class="row-odd"><td><p>pattern</p></td>
-<td><p>^\.\/(.*)\.xml$</p></td>
+<td><p>^(.\/)*(.*)\.xml$</p></td>
+</tr>
+<tr class="row-even"><td rowspan="6"><ul class="simple">
+<li><p>geo_file_paths</p></li>
+</ul>
+</td>
+<td colspan="3"><p>Path(s) to geometry file(s) to switch to in OpenMC code runs</p></td>
+</tr>
+<tr class="row-odd"><td><p>type</p></td>
+<td colspan="2"><p><em>array</em></p></td>
+</tr>
+<tr class="row-even"><td><p>default</p></td>
+<td colspan="2"><p>geometry.xml</p></td>
+</tr>
+<tr class="row-odd"><td rowspan="2"><p>items</p></td>
+<td><p>type</p></td>
+<td><p><em>string</em></p></td>
+</tr>
+<tr class="row-even"><td><p>pattern</p></td>
+<td><p>^(.\/)*(.*)\.xml$</p></td>
+</tr>
+<tr class="row-odd"><td><p>minItems</p></td>
+<td colspan="2"><p>1</p></td>
 </tr>
 <tr class="row-even"><td rowspan="12"><ul class="simple">
 <li><p><strong>simulation</strong></p></li>