Skip to content

Commit d2be770

Browse files
yardasolyardasol
committed
update docs at commit: Merge pull request arfc#122 from yardasol/fix-v0.4.0-releasenotes
Fix v0.4.0 releasenotes + templates c6b3d60
1 parent f658573 commit d2be770

File tree

144 files changed

+3094
-793
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+3094
-793
lines changed

‎master/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: a9ed4fe78b2b985c2f49012844bf440a
3+
config: e6ea8cf7ba301d0d5d5d9deb7dca4562
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎master/.doctrees/devguide/contributing.doctree

22.6 KB
Binary file not shown.

‎master/.doctrees/devguide/index.doctree

5.32 KB
Binary file not shown.

‎master/.doctrees/environment.pickle

38.7 KB
Binary file not shown.

‎master/.doctrees/examples.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/index.doctree

1.58 KB
Binary file not shown.

‎master/.doctrees/installation.doctree

519 Bytes
Binary file not shown.

‎master/.doctrees/overview.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/releasenotes/index.doctree

3.19 KB
Binary file not shown.

‎master/.doctrees/releasenotes/template.doctree

7.63 KB
Binary file not shown.

‎master/.doctrees/releasenotes/v0.3.0.doctree

23.5 KB
Binary file not shown.

‎master/.doctrees/releasenotes/v0.4.0.doctree

41.6 KB
Binary file not shown.

‎master/.doctrees/src/index.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/modules.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.app.doctree

-3.23 KB
Binary file not shown.

‎master/.doctrees/src/saltproc.depcode.doctree

-308 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.materialflow.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.process.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.reactor.doctree

236 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.separator.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.simulation.doctree

2.24 KB
Binary file not shown.

‎master/.doctrees/src/saltproc.sparger.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.tests.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.tests.test_app.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.tests.test_depcode.doctree

1.51 KB
Binary file not shown.

‎master/.doctrees/src/saltproc.tests.test_materialflow.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.tests.test_process.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.tests.test_separator.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.tests.test_simulation.doctree

11.6 KB
Binary file not shown.

‎master/.doctrees/src/saltproc.tests.test_sparger.doctree

0 Bytes
Binary file not shown.

‎master/.doctrees/src/saltproc.version.doctree

0 Bytes
Binary file not shown.

‎master/_modules/index.html

+4-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>Overview: module code &mdash; Saltproc 0.3.1.dev documentation</title>
6+
<title>Overview: module code &mdash; Saltproc 0.4.dev documentation</title>
77
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
99
<!--[if lt IE 9]>
@@ -27,7 +27,7 @@
2727
<a href="../index.html" class="icon icon-home"> Saltproc
2828
</a>
2929
<div class="version">
30-
0.3.1.dev
30+
0.4.dev
3131
</div>
3232
<div role="search">
3333
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -42,6 +42,8 @@
4242
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
4343
<li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
4444
<li class="toctree-l1"><a class="reference internal" href="../src/index.html">SaltProc API</a></li>
45+
<li class="toctree-l1"><a class="reference internal" href="../releasenotes/index.html">Release Notes</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="../devguide/index.html">Developer’s Guide</a></li>
4547
<li class="toctree-l1"><a class="reference external" href="https://github.com/arfc/saltproc/blob/master/CITATION.md">How to cite</a></li>
4648
</ul>
4749

‎master/_modules/saltproc/app.html

+179-162
Large diffs are not rendered by default.

‎master/_modules/saltproc/depcode.html

+128-98
Large diffs are not rendered by default.

‎master/_modules/saltproc/materialflow.html

+4-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>saltproc.materialflow &mdash; Saltproc 0.3.1.dev documentation</title>
6+
<title>saltproc.materialflow &mdash; Saltproc 0.4.dev documentation</title>
77
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
99
<!--[if lt IE 9]>
@@ -27,7 +27,7 @@
2727
<a href="../../index.html" class="icon icon-home"> Saltproc
2828
</a>
2929
<div class="version">
30-
0.3.1.dev
30+
0.4.dev
3131
</div>
3232
<div role="search">
3333
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -42,6 +42,8 @@
4242
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
4343
<li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
4444
<li class="toctree-l1"><a class="reference internal" href="../../src/index.html">SaltProc API</a></li>
45+
<li class="toctree-l1"><a class="reference internal" href="../../releasenotes/index.html">Release Notes</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="../../devguide/index.html">Developer’s Guide</a></li>
4547
<li class="toctree-l1"><a class="reference external" href="https://github.com/arfc/saltproc/blob/master/CITATION.md">How to cite</a></li>
4648
</ul>
4749

‎master/_modules/saltproc/process.html

+4-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>saltproc.process &mdash; Saltproc 0.3.1.dev documentation</title>
6+
<title>saltproc.process &mdash; Saltproc 0.4.dev documentation</title>
77
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
99
<!--[if lt IE 9]>
@@ -27,7 +27,7 @@
2727
<a href="../../index.html" class="icon icon-home"> Saltproc
2828
</a>
2929
<div class="version">
30-
0.3.1.dev
30+
0.4.dev
3131
</div>
3232
<div role="search">
3333
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -42,6 +42,8 @@
4242
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
4343
<li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
4444
<li class="toctree-l1"><a class="reference internal" href="../../src/index.html">SaltProc API</a></li>
45+
<li class="toctree-l1"><a class="reference internal" href="../../releasenotes/index.html">Release Notes</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="../../devguide/index.html">Developer’s Guide</a></li>
4547
<li class="toctree-l1"><a class="reference external" href="https://github.com/arfc/saltproc/blob/master/CITATION.md">How to cite</a></li>
4648
</ul>
4749

‎master/_modules/saltproc/reactor.html

+8-6
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>saltproc.reactor &mdash; Saltproc 0.3.1.dev documentation</title>
6+
<title>saltproc.reactor &mdash; Saltproc 0.4.dev documentation</title>
77
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
99
<!--[if lt IE 9]>
@@ -27,7 +27,7 @@
2727
<a href="../../index.html" class="icon icon-home"> Saltproc
2828
</a>
2929
<div class="version">
30-
0.3.1.dev
30+
0.4.dev
3131
</div>
3232
<div role="search">
3333
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -42,6 +42,8 @@
4242
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
4343
<li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
4444
<li class="toctree-l1"><a class="reference internal" href="../../src/index.html">SaltProc API</a></li>
45+
<li class="toctree-l1"><a class="reference internal" href="../../releasenotes/index.html">Release Notes</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="../../devguide/index.html">Developer’s Guide</a></li>
4547
<li class="toctree-l1"><a class="reference external" href="https://github.com/arfc/saltproc/blob/master/CITATION.md">How to cite</a></li>
4648
</ul>
4749

@@ -79,26 +81,26 @@ <h1>Source code for saltproc.reactor</h1><div class="highlight"><pre>
7981
<span class="n">volume</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span>
8082
<span class="n">mass_flowrate</span><span class="o">=</span><span class="mf">0.0</span><span class="p">,</span>
8183
<span class="n">power_levels</span><span class="o">=</span><span class="p">[</span><span class="mf">0.0</span><span class="p">],</span>
82-
<span class="n">depl_hist</span><span class="o">=</span><span class="p">[</span><span class="mi">1</span><span class="p">]):</span>
84+
<span class="n">dep_step_length_cumulative</span><span class="o">=</span><span class="p">[</span><span class="mi">1</span><span class="p">]):</span>
8385
<span class="sd">&quot;&quot;&quot;Initializes the class.</span>
8486

8587
<span class="sd"> Parameters</span>
8688
<span class="sd"> ----------</span>
8789
<span class="sd"> volume : float</span>
8890
<span class="sd"> Total volume of the reactor core (:math:`cm^3`).</span>
8991
<span class="sd"> mass_flowrate : float</span>
90-
<span class="sd"> Total mass flowrate through reactor (g/s).</span>
92+
<span class="sd"> Total mass flowrate through reactor core (g/s).</span>
9193
<span class="sd"> power_levels : array [:math:`N_{steps}` x1]</span>
9294
<span class="sd"> Normalized power level for each depletion step (W).</span>
93-
<span class="sd"> depl_hist : array [:math:`N_{steps}` x1]</span>
95+
<span class="sd"> dep_step_length_cumulative : array [:math:`N_{steps}` x1]</span>
9496
<span class="sd"> Cumulative depletion time (d).</span>
9597

9698
<span class="sd"> &quot;&quot;&quot;</span>
9799
<span class="c1"># initialize all object attributes</span>
98100
<span class="bp">self</span><span class="o">.</span><span class="n">volume</span> <span class="o">=</span> <span class="n">volume</span>
99101
<span class="bp">self</span><span class="o">.</span><span class="n">mass_flowrate</span> <span class="o">=</span> <span class="n">mass_flowrate</span>
100102
<span class="bp">self</span><span class="o">.</span><span class="n">power_levels</span> <span class="o">=</span> <span class="n">power_levels</span>
101-
<span class="bp">self</span><span class="o">.</span><span class="n">depl_hist</span> <span class="o">=</span> <span class="n">depl_hist</span></div></div>
103+
<span class="bp">self</span><span class="o">.</span><span class="n">dep_step_length_cumulative</span> <span class="o">=</span> <span class="n">dep_step_length_cumulative</span></div></div>
102104
</pre></div>
103105

104106
</div>

‎master/_modules/saltproc/separator.html

+4-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>saltproc.separator &mdash; Saltproc 0.3.1.dev documentation</title>
6+
<title>saltproc.separator &mdash; Saltproc 0.4.dev documentation</title>
77
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
99
<!--[if lt IE 9]>
@@ -27,7 +27,7 @@
2727
<a href="../../index.html" class="icon icon-home"> Saltproc
2828
</a>
2929
<div class="version">
30-
0.3.1.dev
30+
0.4.dev
3131
</div>
3232
<div role="search">
3333
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -42,6 +42,8 @@
4242
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
4343
<li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
4444
<li class="toctree-l1"><a class="reference internal" href="../../src/index.html">SaltProc API</a></li>
45+
<li class="toctree-l1"><a class="reference internal" href="../../releasenotes/index.html">Release Notes</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="../../devguide/index.html">Developer’s Guide</a></li>
4547
<li class="toctree-l1"><a class="reference external" href="https://github.com/arfc/saltproc/blob/master/CITATION.md">How to cite</a></li>
4648
</ul>
4749

0 commit comments

Comments
 (0)