-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
246 lines (167 loc) · 9.84 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>PyRK — pyrk documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="pyrk documentation" href="#"/>
<link rel="next" title="Overview" href="overview.html"/>
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="#" class="fa fa-home"> pyrk</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#the-prke">The PRKE</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#lumped-parameter-th">Lumped Parameter TH</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#material-library">Material Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#data-library">Data Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#the-future">The Future</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="installing.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">PyRK Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/index.html">PyRK API</a></li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">pyrk</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>PyRK</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<div class="section" id="pyrk">
<h1>PyRK<a class="headerlink" href="#pyrk" title="Permalink to this headline">¶</a></h1>
<a class="reference internal image-reference" href="_images/logo.png"><img alt="PyRK logo" src="_images/logo.png" style="width: 25%;" /></a>
<p><strong>PyRK</strong> is a python package for nuclear reactor kinetics. It uses a point
reactor kinetics model and provides an object oriented simulation environment
intended for transient simulations for reactors. It should perk you right up,
like a good cup of coffee.</p>
<p><strong>PyRK</strong> welcomes your contributions. It already relies on many libraries in
the Scientific Python ecosystem including <a class="reference external" href="http://numpy.org">numpy</a>, <a class="reference external" href="http://scipy.org">scipy</a>, <a class="reference external" href="http://pint.readthedocs.org">pint</a>, and
<a class="reference external" href="http://matplotlib.org">matplotlib</a>.</p>
<div class="section" id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="installing.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">PyRK Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/index.html">PyRK API</a></li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li>
</ul>
</div>
<div class="section" id="citation">
<h2>Citation<a class="headerlink" href="#citation" title="Permalink to this headline">¶</a></h2>
<p>Up-to-date information about citing PyRK can be found within the <a class="reference external" href="https://github.com/pyrk/pyrk/blob/master/CITATION.md">citation</a>
file.</p>
</div>
<div class="section" id="see-also">
<h2>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Katy Huff’s <a class="reference external" href="https://www.youtube.com/watch?v=2HToG61wMWI">SciPy2015 talk</a> introducing PyRK to an interdisciplinary audience.</li>
<li>The associated <a class="reference external" href="http://pyrk.github.io/scipy-2015">Scipy2015 slides</a></li>
<li>The associated short <a class="reference external" href="http://conference.scipy.org/proceedings/scipy2015/kathryn_huff.html">SciPy2015 paper</a> from the conference describing the software structure.</li>
<li>Xin Wang’s <a class="reference external" href="http://icapp.ans.org">ICAPP paper</a> using PyRK for PBFHR analysis.</li>
</ul>
</div>
<div class="section" id="get-in-touch">
<h2>Get in touch<a class="headerlink" href="#get-in-touch" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Please report bugs, suggest feature ideas, and browse the source code <a class="reference external" href="http://github.com/pyrk/pyrk">on GitHub</a>.</li>
<li>There, new contributors can also find <a class="reference external" href="https://github.com/pyrk/pyrk/blob/master/CONTRIBUTING.md">a guide to contributing</a>.</li>
<li>You can also contact Katy <a class="reference external" href="http://twitter.com/katyhuff">on Twitter</a>.</li>
</ul>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p>PyRK is available under the open source <a class="reference external" href="https://raw.githubusercontent.com/pyrk/pyrk/master/licenses/LICENSE">BSD 3-clause License</a>.</p>
</div>
<div class="section" id="history">
<h2>History<a class="headerlink" href="#history" title="Permalink to this headline">¶</a></h2>
<p>PyRK was originally developed for analysis of accident transients in the
Pebble-Bed, Fluoride-Salt-Cooled, High-Temperature Reactor (<a class="reference external" href="http://fhr.nuc.berkeley.edu/pb-fhr-technology/">PB-FHR</a>) design. It was
originally written by Kathryn Huff who is supported by the Nuclear Science and
Security Consortium (<a class="reference external" href="http://nssc.berkeley.edu/">NSSC</a>) as well as the <a class="reference external" href="http://fhr.nuc.berkeley.edu/">FHR Project</a> and the Berkeley
Institute for Data Science (<a class="reference external" href="http://bids.berkeley.edu/">BIDS</a>) at Berkeley. Colleagues that contributed
feedback in this endeavor include Xin Wang, Per Peterson, Ehud Greenspan, and
Massimiliano Fratoni at the University of California Berkeley.</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="overview.html" class="btn btn-neutral float-right" title="Overview">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2015, Kathryn D. Huff.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>