Skip to content

Commit

Permalink
update docs at commit: Merge pull request #122 from yardasol/fix-v0.4…
Browse files Browse the repository at this point in the history
….0-releasenotes

Fix v0.4.0 releasenotes + templates c6b3d60
  • Loading branch information
abachma2 committed Feb 15, 2022
1 parent f9aabd8 commit 5e5d6c6
Show file tree
Hide file tree
Showing 63 changed files with 51 additions and 42 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: 52f4bea6dc465d51ad7ff372ea1c35de
config: 137584d6fc834c7f5f22fbee2cd9af28
tags: 645f666f9bcd5a90fca523b33c5a78b7
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/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/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/src/index.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/modules.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.app.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.depcode.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.materialflow.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.process.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.reactor.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.separator.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.simulation.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.sparger.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.tests.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.tests.test_app.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.tests.test_depcode.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.tests.test_materialflow.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.tests.test_process.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.tests.test_separator.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.tests.test_simulation.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.tests.test_sparger.doctree
Binary file not shown.
Binary file modified master/.doctrees/src/saltproc.version.doctree
Binary file not shown.
26 changes: 10 additions & 16 deletions master/_sources/releasenotes/template.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
Release notes for vx.x.x
========================

.. note:: These release notes are currently in production.

..
When documenting a bug fix or feature, please do so in the following format
Expand All @@ -14,69 +16,62 @@ Release notes for vx.x.x



-------
Summary
-------
=======

..
Describe generally the features of this release



------------------
Dependency Changes
------------------
==================

..
Describe any new/removed/modified package dependencies



------------
New Features
------------
============

..
Describe any new features to the code.



---------
Bug Fixes
---------
=========

..
Describe any bug fixes.



--------------
Script Changes
--------------
==============

..
Describe any script additions/modifications/removals



------------------
Python API Changes
------------------
==================

..
Describe any changes to the API



------------
Contributors
------------
============
..
List of people who contributed features and fixes to this release
Expand All @@ -88,9 +83,8 @@ The following people contributed code to this release of SaltProc:



---------
Reviewers
---------
=========
..
List of people who reviewed PRs for this release
Expand Down
41 changes: 21 additions & 20 deletions master/_sources/releasenotes/v0.4.0.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
Release notes for v0.4.0
========================

.. note:: These release notes are currently in production.

..
When documenting a bug fix or feature, please do so in the following format
Expand All @@ -14,23 +16,23 @@ Release notes for v0.4.0
.. _jsonschema: https://github.com/Julian/jsonschema
.. _@yardasol: https://github.com/yardasol
.. _@abachma2: https://github.com/abachma2
.. _@ZoeRichter: https://github.com/ZoeRichter
.. _@gwenchee: https://github.com/gwenchee
.. _@LukeSeifert: https://github.com/LukeSeifert
.. _@munkm: https://github.com/munkm


-------
Summary
-------
=======

..
Describe generally the features of this release
This version of SaltProc refactors the code in preparation for supporting OpenMC.


------------------
Dependency Changes
------------------
==================

..
Describe any new/removed/modified package dependencies
Expand All @@ -40,43 +42,39 @@ Dependency Changes
- (new) → `jsonschema`_


------------
New Features
------------
============

..
Describe any new features to the code.
- `Refactor app.py and simulation.py to prepare for OpenMC support <https://github.com/arfc/saltproc/pull/98>`_ by `@yardasol`_
- `New input file format that is checked against a verifiable JSON Schema <https://github.com/arfc/saltproc/pull/98>`_ by `@yardasol`_
- `Release notes in the online docs <https://github.com/arfc/saltproc/pull/105>`_ by `@yardasol`_
- `Release notes in the online docs <https://github.com/arfc/saltproc/pull/115>`_ by `@yardasol`_


---------
Bug Fixes
---------
=========

..
Describe any bug fixes.
- `Fix typos in process_j312.bash <https://github.com/arfc/saltproc/pull/100>`_


--------------
Script Changes
--------------
==============

..
Describe any script additions/modifications/removals
- The following scripts hav been renamed:
- The following scripts have been renamed:

- ``process_j312.sh`` → ``process_j312.bash``


------------------
Python API Changes
------------------
==================

- New tests for previously untested functions in ``simulation.py``:

Expand All @@ -96,6 +94,9 @@ Python API Changes
- (new) → ``Depcode.switch_to_next_geometry``
- (new) → ``Depcode.read_depcode_info``
- (new) → ``Depcode.read_repcode_step_param``
- ``DepcodeSerpent.sss_meta_zzz`` → ``DepcodeSerpent.convert_nuclide_name_serpent_to_zam``
- ``DepcodeSerpent.get_tra_or_dec`` → ``DepcodeSerpent.create_nuclide_name_map_zam_to_serpent``
- ``DepcodeSerpent.read_depcode_template`` → ``DepcodeSerpent.read_plaintext_file``

- Updated input file structure:

Expand All @@ -121,7 +122,7 @@ Python API Changes
- (new) → ``App.reactor_inp['volume']``
- (new) → ``App.reactor_inp['mass_flowrate']``
- ``App.power_levels``
- ``App.depl_hist``
- ``App.depl_hist`` → ``App.reactor_inp['dep_step_length_cumulative']``

- The following class attributes have been added/(re)moved:

Expand All @@ -144,11 +145,10 @@ Python API Changes
- ``Depcode.write_depcode_input``
- ``Depcode.write_mat_file``
- ``DepcodeSerpent.read_depcode_template``
- ``DepcodeSerpent.create_nuclide_map_serpent_to_zam``


------------
Contributors
------------
============

..
List of people who contributed features and fixes to this release
Expand All @@ -161,9 +161,8 @@ The following people contributed code to this release of SaltProc:
- `@yardasol`_


---------
Reviewers
---------
=========

..
List of people who reviewed PRs for this release
Expand All @@ -174,5 +173,7 @@ The following people reviewed code for this release of SaltProc:
`@gh_username <https://github.com/gh_uname>`_
- `@abachma2`_
- `@ZoeRichter`_
- `@gwenchee`_
- `@LukeSeifert`_
- `@munkm`_
4 changes: 4 additions & 0 deletions master/releasenotes/template.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@

<section id="release-notes-for-vx-x-x">
<h1>Release notes for vx.x.x<a class="headerlink" href="#release-notes-for-vx-x-x" title="Permalink to this headline"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>These release notes are currently in production.</p>
</div>
<section id="summary">
<h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headline"></a></h2>
</section>
Expand Down
16 changes: 13 additions & 3 deletions master/releasenotes/v0.4.0.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@

<section id="release-notes-for-v0-4-0">
<h1>Release notes for v0.4.0<a class="headerlink" href="#release-notes-for-v0-4-0" title="Permalink to this headline"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>These release notes are currently in production.</p>
</div>
<section id="summary">
<h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headline"></a></h2>
<p>This version of SaltProc refactors the code in preparation for supporting OpenMC.</p>
Expand All @@ -110,7 +114,7 @@ <h2>New Features<a class="headerlink" href="#new-features" title="Permalink to t
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/arfc/saltproc/pull/98">Refactor app.py and simulation.py to prepare for OpenMC support</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/pull/98">New input file format that is checked against a verifiable JSON Schema</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/pull/105">Release notes in the online docs</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/pull/115">Release notes in the online docs</a> by <a class="reference external" href="https://github.com/yardasol">&#64;yardasol</a></p></li>
</ul>
</section>
<section id="bug-fixes">
Expand All @@ -122,7 +126,7 @@ <h2>Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this he
<section id="script-changes">
<h2>Script Changes<a class="headerlink" href="#script-changes" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>The following scripts hav been renamed:</p>
<li><p>The following scripts have been renamed:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">process_j312.sh</span></code><code class="docutils literal notranslate"><span class="pre">process_j312.bash</span></code></p></li>
</ul>
Expand Down Expand Up @@ -151,6 +155,9 @@ <h2>Python API Changes<a class="headerlink" href="#python-api-changes" title="Pe
<li><p>(new) → <code class="docutils literal notranslate"><span class="pre">Depcode.switch_to_next_geometry</span></code></p></li>
<li><p>(new) → <code class="docutils literal notranslate"><span class="pre">Depcode.read_depcode_info</span></code></p></li>
<li><p>(new) → <code class="docutils literal notranslate"><span class="pre">Depcode.read_repcode_step_param</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DepcodeSerpent.sss_meta_zzz</span></code><code class="docutils literal notranslate"><span class="pre">DepcodeSerpent.convert_nuclide_name_serpent_to_zam</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DepcodeSerpent.get_tra_or_dec</span></code><code class="docutils literal notranslate"><span class="pre">DepcodeSerpent.create_nuclide_name_map_zam_to_serpent</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DepcodeSerpent.read_depcode_template</span></code><code class="docutils literal notranslate"><span class="pre">DepcodeSerpent.read_plaintext_file</span></code></p></li>
</ul>
</li>
<li><p>Updated input file structure:</p>
Expand Down Expand Up @@ -179,7 +186,7 @@ <h2>Python API Changes<a class="headerlink" href="#python-api-changes" title="Pe
<li><p>(new) → <code class="docutils literal notranslate"><span class="pre">App.reactor_inp['volume']</span></code></p></li>
<li><p>(new) → <code class="docutils literal notranslate"><span class="pre">App.reactor_inp['mass_flowrate']</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">App.power_levels</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">App.depl_hist</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">App.depl_hist</span></code><code class="docutils literal notranslate"><span class="pre">App.reactor_inp['dep_step_length_cumulative']</span></code></p></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -209,6 +216,7 @@ <h2>Python API Changes<a class="headerlink" href="#python-api-changes" title="Pe
<li><p><code class="docutils literal notranslate"><span class="pre">Depcode.write_depcode_input</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Depcode.write_mat_file</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DepcodeSerpent.read_depcode_template</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DepcodeSerpent.create_nuclide_map_serpent_to_zam</span></code></p></li>
</ul>
</li>
</ul>
Expand All @@ -225,6 +233,8 @@ <h2>Reviewers<a class="headerlink" href="#reviewers" title="Permalink to this he
<p>The following people reviewed code for this release of SaltProc:</p>
<ul class="simple">
<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/ZoeRichter">&#64;ZoeRichter</a></p></li>
<li><p><a class="reference external" href="https://github.com/gwenchee">&#64;gwenchee</a></p></li>
<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>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion master/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion v0.3.0/.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: 77faa970f0cad3379acf52a083b3df47
config: 8e3578ed88e734b9c83a5b82f3e3f878
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified v0.3.0/.doctrees/environment.pickle
Binary file not shown.
Binary file modified v0.3.0/.doctrees/examples.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/index.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/installation.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/overview.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/index.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/modules.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.app.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.depcode.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.materialflow.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.process.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.reactor.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.separator.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.simulation.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.sparger.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.tests.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.tests.test_app.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.tests.test_depcode.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.tests.test_materialflow.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.tests.test_process.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.tests.test_separator.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.tests.test_simulation.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.tests.test_sparger.doctree
Binary file not shown.
Binary file modified v0.3.0/.doctrees/src/saltproc.version.doctree
Binary file not shown.

0 comments on commit 5e5d6c6

Please sign in to comment.