Skip to content

Commit

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

Cleanup v0.5.0 releasenote formatting e47ef8d
  • Loading branch information
khurrumsaleem committed Feb 28, 2024
1 parent 5d12f17 commit 19e5559
Show file tree
Hide file tree
Showing 109 changed files with 150 additions and 151 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: 4be4c9d6638ec8112de6519bf51a631b
config: 8abb39e455c2723da542e408ec08b15d
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.
4 changes: 2 additions & 2 deletions master/_modules/app.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>app &mdash; Saltproc 0.5.dev documentation</title>
<title>app &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -29,7 +29,7 @@
<a href="../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; Saltproc 0.5.dev documentation</title>
<title>Overview: module code &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -29,7 +29,7 @@
<a href="../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/_modules/saltproc/depcode.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>saltproc.depcode &mdash; Saltproc 0.5.dev documentation</title>
<title>saltproc.depcode &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -29,7 +29,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/_modules/saltproc/materialflow.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>saltproc.materialflow &mdash; Saltproc 0.5.dev documentation</title>
<title>saltproc.materialflow &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -29,7 +29,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/_modules/saltproc/openmc_depcode.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>saltproc.openmc_depcode &mdash; Saltproc 0.5.dev documentation</title>
<title>saltproc.openmc_depcode &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -29,7 +29,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/_modules/saltproc/process.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>saltproc.process &mdash; Saltproc 0.5.dev documentation</title>
<title>saltproc.process &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -29,7 +29,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/_modules/saltproc/separator.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>saltproc.separator &mdash; Saltproc 0.5.dev documentation</title>
<title>saltproc.separator &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -29,7 +29,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/_modules/saltproc/serpent_depcode.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>saltproc.serpent_depcode &mdash; Saltproc 0.5.dev documentation</title>
<title>saltproc.serpent_depcode &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -29,7 +29,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/_modules/saltproc/simulation.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>saltproc.simulation &mdash; Saltproc 0.5.dev documentation</title>
<title>saltproc.simulation &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -29,7 +29,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/_modules/saltproc/sparger.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>saltproc.sparger &mdash; Saltproc 0.5.dev documentation</title>
<title>saltproc.sparger &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -29,7 +29,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
32 changes: 16 additions & 16 deletions master/_sources/releasenotes/v0.5.0.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Release notes for v0.5.0
========================

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


..
When documenting a bug fix or feature, please do so in the following format
Expand Down 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>`_
2 changes: 1 addition & 1 deletion master/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.5.dev',
VERSION: '0.5.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions master/api/app.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>saltproc.app &mdash; Saltproc 0.5.dev documentation</title>
<title>saltproc.app &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -30,7 +30,7 @@
<a href="../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/api/generated/app.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>app &mdash; Saltproc 0.5.dev documentation</title>
<title>app &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down Expand Up @@ -32,7 +32,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/api/generated/app.read_main_input.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>app.read_main_input &mdash; Saltproc 0.5.dev documentation</title>
<title>app.read_main_input &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -30,7 +30,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/api/generated/app.refill_materials.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>app.refill_materials &mdash; Saltproc 0.5.dev documentation</title>
<title>app.refill_materials &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -30,7 +30,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions master/api/generated/app.reprocess_materials.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>app.reprocess_materials &mdash; Saltproc 0.5.dev documentation</title>
<title>app.reprocess_materials &mdash; Saltproc 0.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -30,7 +30,7 @@
<a href="../../index.html" class="icon icon-home"> Saltproc
</a>
<div class="version">
0.5.dev
0.5.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
Loading

0 comments on commit 19e5559

Please sign in to comment.