Skip to content

Commit

Permalink
update docs at commit: Merge pull request #201 from yardasol/v0.5.0-r…
Browse files Browse the repository at this point in the history
…eleasenotes

Cleanup v0.5.0 releasenote formatting e47ef8d
  • Loading branch information
LukeSeifert committed Feb 26, 2024
1 parent 8d90627 commit 9af6084
Show file tree
Hide file tree
Showing 50 changed files with 32 additions and 29 deletions.
2 changes: 1 addition & 1 deletion master/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: 4ebc85193116ca8b42f314ee0b94ebdb
config: bd33fcd01e0f5e9f2a1e9c834ba5273a
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified master/.doctrees/api/app.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/app.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/app.read_main_input.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/app.refill_materials.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/app.reprocess_materials.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/app.run.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/saltproc.Depcode.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/saltproc.Materialflow.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/saltproc.OpenMCDepcode.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/saltproc.Process.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/saltproc.Separator.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/saltproc.SerpentDepcode.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/saltproc.Simulation.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/generated/saltproc.Sparger.doctree
Binary file not shown.
Binary file modified master/.doctrees/api/index.doctree
Binary file not shown.
Binary file modified master/.doctrees/devguide/contributing.doctree
Binary file not shown.
Binary file modified master/.doctrees/devguide/index.doctree
Binary file not shown.
Binary file modified master/.doctrees/devguide/style.doctree
Binary file not shown.
Binary file modified master/.doctrees/devguide/tests.doctree
Binary file not shown.
Binary file modified master/.doctrees/environment.pickle
Binary file not shown.
Binary file modified master/.doctrees/examples.doctree
Binary file not shown.
Binary file modified master/.doctrees/index.doctree
Binary file not shown.
Binary file modified master/.doctrees/installation.doctree
Binary file not shown.
Binary file modified master/.doctrees/io_formats/databasefile.doctree
Binary file not shown.
Binary file modified master/.doctrees/io_formats/depcode_input.doctree
Binary file not shown.
Binary file modified master/.doctrees/io_formats/index.doctree
Binary file not shown.
Binary file modified master/.doctrees/io_formats/reactor_input.doctree
Binary file not shown.
Binary file modified master/.doctrees/io_formats/saltproc_input.doctree
Binary file not shown.
Binary file modified master/.doctrees/io_formats/simulation_input.doctree
Binary file not shown.
Binary file modified master/.doctrees/methods/index.doctree
Binary file not shown.
Binary file modified master/.doctrees/methods/reprocessing.doctree
Binary file not shown.
Binary file modified master/.doctrees/overview.doctree
Binary file not shown.
Binary file modified master/.doctrees/releasenotes/index.doctree
Binary file not shown.
Binary file modified master/.doctrees/releasenotes/template.doctree
Binary file not shown.
Binary file modified master/.doctrees/releasenotes/v0.3.0.doctree
Binary file not shown.
Binary file modified master/.doctrees/releasenotes/v0.4.0.doctree
Binary file not shown.
Binary file modified master/.doctrees/releasenotes/v0.5.0.doctree
Binary file not shown.
Binary file modified master/.doctrees/userguide/basics.doctree
Binary file not shown.
Binary file modified master/.doctrees/userguide/beginners.doctree
Binary file not shown.
Binary file modified master/.doctrees/userguide/index.doctree
Binary file not shown.
Binary file modified master/.doctrees/userguide/input.doctree
Binary file not shown.
Binary file modified master/.doctrees/userguide/parallel.doctree
Binary file not shown.
Binary file modified master/.doctrees/userguide/processing_system.doctree
Binary file not shown.
Binary file modified master/.doctrees/userguide/scripts.doctree
Binary file not shown.
Binary file modified master/.doctrees/userguide/templates.doctree
Binary file not shown.
Binary file modified master/.doctrees/userguide/troubleshooting.doctree
Binary file not shown.
30 changes: 15 additions & 15 deletions master/_sources/releasenotes/v0.5.0.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Dependency Changes
Describe any new/removed/modified package dependencies

- ``SaltProc`` now requires the following package:
- ``SaltProc`` now requires the following packages:

- (new) → `openmc`_
- (new) → `serpentTools`_
Expand Down Expand Up @@ -70,8 +70,9 @@ 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>`
- `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>`_ by `@yardasol`_
- `Fix bug where using MCNP-style ZAID codes results in an error in various SerpentDepcode functions <https://github.com/arfc/saltproc/issues/187>`_ by `@yardasol`_
- `Fix bug where only one array of OpenMC Materials are stored in results <https://github.com/arfc/saltproc/issues/196>`_ by `@yardasol`_



Expand Down Expand Up @@ -106,10 +107,10 @@ Python API Changes
- Input file format changes:

- Removed the ``-n`` command line argument in favor of the new ``mpi_args`` input parameter
- Chaged the ``-d`` command line argument to ``-s``/``--threads``.
- Changed 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 a ``zaid_convention`` input parameter
- Added depletion settings for OpenMC
- ``num_depsteps`` → ``n_depletion_steps``
- ``depcode['template_inputfile_path']`` → ``depcode['template_input_file_path']``
Expand All @@ -135,7 +136,7 @@ Python API Changes

- ``Depcode``

- Add `output_path` parameter.
- Added `output_path` parameter.
- ``template_inputfile_path`` → ``template_input_file_path``
- Removed default values for `geo_files`
- Changed `iter_inputfile`, `iter_matfile` to be attributes instead of parameters
Expand All @@ -154,7 +155,7 @@ Python API Changes

- ``DepcodeSerpent`` → ``SerpentDepcode``

- Add `output_path` parameter.
- Added `output_path` parameter.
- ``template_inputfile_path`` → ``template_input_file_path``
- Removed default values for `exec_path`, `template_input_file_path`, `geo_files`
- Changed `iter_inputfile`, `iter_matfile` to be attributes instead of parameters
Expand Down Expand Up @@ -198,13 +199,13 @@ Python API Changes

- ``reprocessing()`` → ``reprocess_materials()``
- ``refill()`` → ``refill_materials()``
- ``read_feeds_from_input`` → ``get_feeds()``
- ``read_processes_from_input`` → ``get_extraction_processes()``
- ``read_feeds_from_input()`` → ``get_feeds()``
- ``read_processes_from_input()`` → ``get_extraction_processes()``
- ``read_dot()`` → ``get_extraction_process_paths()``

- ``Process``

- ``calc_rem_efficiency()`` → ``calculate_removal_efficiency``
- ``calc_rem_efficiency()`` → ``calculate_removal_efficiency()``

- ``Reactor``

Expand All @@ -224,11 +225,11 @@ Python API Changes

- ``Sparger``

- ``calc_rem_efficiency()`` → ``calculate_removal_efficiency``
- ``calc_rem_efficiency()`` → ``calculate_removal_efficiency()``

- ``Separator``

- ``calc_rem_efficiency()`` → ``calculate_removal_efficiency``
- ``calc_rem_efficiency()`` → ``calculate_removal_efficiency()``


Contributors
Expand Down Expand Up @@ -260,6 +261,5 @@ The following people reviewed code for this release of SaltProc:
- `@LukeSeifert <https://github.com/LukeSeifert>`_
- `@munkm <https://github.com/munkm>`_
- `@abachma2 <https://github.com/abachma2>`_



- `@samgdotson <https://github.com/samgdotson>`_
- `@ZoeRichter <https://github.com/ZoeRichter>`_
27 changes: 15 additions & 12 deletions master/releasenotes/v0.5.0.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headin
<section id="dependency-changes">
<h2>Dependency Changes<a class="headerlink" href="#dependency-changes" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">SaltProc</span></code> now requires the following package:</p>
<li><p><code class="docutils literal notranslate"><span class="pre">SaltProc</span></code> now requires the following packages:</p>
<ul>
<li><p>(new) → <a class="reference external" href="https://github.com/openmc-dev/openmc">openmc</a></p></li>
<li><p>(new) → <a class="reference external" href="https://github.com/CORE-GATECH-GROUP/serpent-tools">serpentTools</a></p></li>
Expand All @@ -126,8 +126,9 @@ <h2>New Features<a class="headerlink" href="#new-features" title="Permalink to t
<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>
<li><p><a class="reference external" href="https://github.com/arfc/saltproc/pull/178">Fix bug where Serpent2 material temperatures are hardcoded to 900K in the JEFF 3.1.2 library format.</a> by <a class="reference external" href="https://github.com/yardasol">&#64;yardasol</a></p></li>
<li><p><a class="reference external" href="https://github.com/arfc/saltproc/issues/187">Fix bug where using MCNP-style ZAID codes results in an error in various SerpentDepcode functions</a> by <a class="reference external" href="https://github.com/yardasol">&#64;yardasol</a></p></li>
<li><p><a class="reference external" href="https://github.com/arfc/saltproc/issues/196">Fix bug where only one array of OpenMC Materials are stored in results</a> by <a class="reference external" href="https://github.com/yardasol">&#64;yardasol</a></p></li>
</ul>
</section>
<section id="script-changes">
Expand All @@ -153,10 +154,10 @@ <h2>Python API Changes<a class="headerlink" href="#python-api-changes" title="Pe
<li><p>Input file format changes:</p>
<ul>
<li><p>Removed the <code class="docutils literal notranslate"><span class="pre">-n</span></code> command line argument in favor of the new <code class="docutils literal notranslate"><span class="pre">mpi_args</span></code> input parameter</p></li>
<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>Changed 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 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>
Expand Down Expand Up @@ -188,7 +189,7 @@ <h2>Python API Changes<a class="headerlink" href="#python-api-changes" title="Pe
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">Depcode</span></code></p>
<ul>
<li><p>Add <cite>output_path</cite> parameter.</p></li>
<li><p>Added <cite>output_path</cite> parameter.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">template_inputfile_path</span></code><code class="docutils literal notranslate"><span class="pre">template_input_file_path</span></code></p></li>
<li><p>Removed default values for <cite>geo_files</cite></p></li>
<li><p>Changed <cite>iter_inputfile</cite>, <cite>iter_matfile</cite> to be attributes instead of parameters</p></li>
Expand All @@ -208,7 +209,7 @@ <h2>Python API Changes<a class="headerlink" href="#python-api-changes" title="Pe
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">DepcodeSerpent</span></code><code class="docutils literal notranslate"><span class="pre">SerpentDepcode</span></code></p>
<ul>
<li><p>Add <cite>output_path</cite> parameter.</p></li>
<li><p>Added <cite>output_path</cite> parameter.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">template_inputfile_path</span></code><code class="docutils literal notranslate"><span class="pre">template_input_file_path</span></code></p></li>
<li><p>Removed default values for <cite>exec_path</cite>, <cite>template_input_file_path</cite>, <cite>geo_files</cite></p></li>
<li><p>Changed <cite>iter_inputfile</cite>, <cite>iter_matfile</cite> to be attributes instead of parameters</p></li>
Expand Down Expand Up @@ -250,14 +251,14 @@ <h2>Python API Changes<a class="headerlink" href="#python-api-changes" title="Pe
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">reprocessing()</span></code><code class="docutils literal notranslate"><span class="pre">reprocess_materials()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">refill()</span></code><code class="docutils literal notranslate"><span class="pre">refill_materials()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">read_feeds_from_input</span></code><code class="docutils literal notranslate"><span class="pre">get_feeds()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">read_processes_from_input</span></code><code class="docutils literal notranslate"><span class="pre">get_extraction_processes()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">read_feeds_from_input()</span></code><code class="docutils literal notranslate"><span class="pre">get_feeds()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">read_processes_from_input()</span></code><code class="docutils literal notranslate"><span class="pre">get_extraction_processes()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">read_dot()</span></code><code class="docutils literal notranslate"><span class="pre">get_extraction_process_paths()</span></code></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">Process</span></code></p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">calc_rem_efficiency()</span></code><code class="docutils literal notranslate"><span class="pre">calculate_removal_efficiency</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">calc_rem_efficiency()</span></code><code class="docutils literal notranslate"><span class="pre">calculate_removal_efficiency()</span></code></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">Reactor</span></code></p>
Expand All @@ -281,12 +282,12 @@ <h2>Python API Changes<a class="headerlink" href="#python-api-changes" title="Pe
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">Sparger</span></code></p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">calc_rem_efficiency()</span></code><code class="docutils literal notranslate"><span class="pre">calculate_removal_efficiency</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">calc_rem_efficiency()</span></code><code class="docutils literal notranslate"><span class="pre">calculate_removal_efficiency()</span></code></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">Separator</span></code></p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">calc_rem_efficiency()</span></code><code class="docutils literal notranslate"><span class="pre">calculate_removal_efficiency</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">calc_rem_efficiency()</span></code><code class="docutils literal notranslate"><span class="pre">calculate_removal_efficiency()</span></code></p></li>
</ul>
</li>
</ul>
Expand All @@ -308,6 +309,8 @@ <h2>Reviewers<a class="headerlink" href="#reviewers" title="Permalink to this he
<li><p><a class="reference external" href="https://github.com/LukeSeifert">&#64;LukeSeifert</a></p></li>
<li><p><a class="reference external" href="https://github.com/munkm">&#64;munkm</a></p></li>
<li><p><a class="reference external" href="https://github.com/abachma2">&#64;abachma2</a></p></li>
<li><p><a class="reference external" href="https://github.com/samgdotson">&#64;samgdotson</a></p></li>
<li><p><a class="reference external" href="https://github.com/ZoeRichter">&#64;ZoeRichter</a></p></li>
</ul>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion master/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 9af6084

Please sign in to comment.