forked from lkilcher/pyTurbSim
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
207 lines (190 loc) · 10.8 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to PyTurbSim’s home page — PyTurbSim 0.4.8 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.4.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="About" href="about.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="welcome-to-pyturbsim-s-home-page">
<h1>Welcome to PyTurbSim’s home page<a class="headerlink" href="#welcome-to-pyturbsim-s-home-page" title="Permalink to this headline">¶</a></h1>
<p>PyTurbSim is a program for producing simulations of turbulent velocity
time-series for input to device simulation tools that estimate water-
and wind-turbine performance and loads. PyTurbSim outputs spatial
time-series (a sequence of 2-D, y-z, planes) of 3-component velocity
(u,v,w) that match statistics of real oceanic, riverine and wind
turbulence <a class="footnote-reference" href="#id2" id="id1">[1]</a>. In other words, PyTurbSim provides the inflow
information that ‘drives’ device simulations. See the <a class="reference internal" href="about.html#about"><span class="std std-ref">About</span></a>
page for more information.</p>
<p>PyTurbSim is the official water-turbulence simulation tool for
hydrokinetic turbine device simulation (a.k.a. HydroTurbSim), and is
also a valuable development and testing platform for NREL’s ‘TurbSim’
tool (see <a class="reference internal" href="about.html#about-history"><span class="std std-ref">History</span></a>). New mean-profile, spectral and
coherence models can be implemented easily in a pythonic,
object-oriented manner, and plotting routines for comparing output
to targets and/or data are included.</p>
</div>
<div class="section" id="table-of-contents">
<h1>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about.html#history">History</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Download and Install</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-without-pip">Installing without pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#windows-installation-issues">Windows Installation Issues</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#input-files">1) Input files</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#advanced-programming-interface-api">2) Advanced programming interface (API)</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#reading-output-files">Reading output files</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plotting-tools.html">Plotting Tools</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plotting-tools.html#generate-some-pyts-data">Generate some PyTurbSim data</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting-tools.html#basic-plotting">Basic plotting</a></li>
<li class="toctree-l2"><a class="reference internal" href="plotting-tools.html#advanced-usage">Advanced Usage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="code-framework.html">Code Framework</a><ul>
<li class="toctree-l2"><a class="reference internal" href="code-framework.html#models-vs-run-specific-statistics">Models vs. run-specific ‘statistics’</a><ul>
<li class="toctree-l3"><a class="reference internal" href="code-framework.html#models">Models</a></li>
<li class="toctree-l3"><a class="reference internal" href="code-framework.html#stat-objects-arrays">Stat-objects/arrays</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="code-framework.html#customizing-pyturbsim">Customizing PyTurbSim</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/pyts.html">pyts package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/pyts.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/pyts.cohereModels.html">pyts.cohereModels package</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/pyts.io.html">pyts.io package</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/pyts.phaseModels.html">pyts.phaseModels package</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/pyts.plot.html">pyts.plot package</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/pyts.profModels.html">pyts.profModels package</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/pyts.runInput.html">pyts.runInput package</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/pyts.specModels.html">pyts.specModels package</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/pyts.stressModels.html">pyts.stressModels package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/pyts.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/pyts.html#module-pyts.api">pyts.api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/pyts.html#module-pyts.base">pyts.base module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/pyts.html#module-pyts.dbg">pyts.dbg module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/pyts.html#module-pyts.main">pyts.main module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/pyts.html#module-pyts.misc">pyts.misc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/pyts.html#module-pyts.pyts_numpy">pyts.pyts_numpy module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/pyts.html#module-pyts">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>
</div>
</div>
<div class="section" id="indices-tables-and-notes">
<h1>Indices, tables and notes<a class="headerlink" href="#indices-tables-and-notes" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
<li><a class="reference internal" href="glossary.html"><span class="doc">Glossary</span></a></li>
</ul>
<table class="docutils footnote" frame="void" id="id2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><p class="first">At the most basic level PyTurbSim output is a four-dimensional
array. The dimensions are:</p>
<ol class="arabic simple">
<li>velocity component (size 3, corresponding to u,v,w),</li>
<li>z spatial dimension (size n_z = number of z-points)</li>
<li>y spatial dimension (size n_y = number of y-points)</li>
<li>time dimension (size n_t = number of timesteps)</li>
</ol>
<p class="last">TurbSim implicitly makes the ‘frozen flow hypothesis’ and so the
time-dimension can also, roughly, be considered the x spatial
dimension.</p>
</td></tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to PyTurbSim’s home page</a></li>
<li><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
<li><a class="reference internal" href="#indices-tables-and-notes">Indices, tables and notes</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="about.html" title="next chapter">About</a></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2018, National Renewable Energy Lab.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
<a href="_sources/index.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>