-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathintroduction.html
More file actions
320 lines (217 loc) · 13.5 KB
/
introduction.html
File metadata and controls
320 lines (217 loc) · 13.5 KB
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
<!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>Introduction — Fusion Data Framework 0.0.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="Fusion Data Framework 0.0.0 documentation" href="index.html"/>
<link rel="next" title="User Guide" href="user_guide.html"/>
<link rel="prev" title="Fusion Data Platform" href="index.html"/>
<script src="_static/js/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-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> Fusion Data Framework
</a>
<div class="version">
0.0
</div>
<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 class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#fusion-data-platform">Fusion Data Platform</a></li>
<li class="toctree-l2"><a class="reference internal" href="#project-objectives">Project objectives</a></li>
<li class="toctree-l2"><a class="reference internal" href="#example-usage">Example usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="#lead-developers">Lead developers</a></li>
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer_guide.html">Developer Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="project_documents.html">Project Documents</a></li>
</ul>
</div>
</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="index.html">Fusion Data Framework</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="index.html">Docs</a> »</li>
<li>Introduction</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/introduction.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
<div class="section" id="fusion-data-platform">
<h2>Fusion Data Platform<a class="headerlink" href="#fusion-data-platform" title="Permalink to this headline">¶</a></h2>
<p>Fusion Data Platform (FDP) is a data framework in Python for magnetic fusion experiments. FDP streamlines data discovery, analysis methods, and visualization.</p>
<ul class="simple">
<li>Github repository: <a class="reference external" href="https://github.com/Fusion-Data-Platform/fdp">https://github.com/Fusion-Data-Platform/fdp</a></li>
<li>Documentation: <a class="reference external" href="http://Fusion-Data-Platform.github.io/">http://Fusion-Data-Platform.github.io/</a></li>
</ul>
</div>
<div class="section" id="project-objectives">
<h2>Project objectives<a class="headerlink" href="#project-objectives" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Integrate data sources, data, and analysis methods in a single, extensible data object<ul>
<li>Streamline data access for multiple facilities, diagnostics, and databases</li>
<li>Organize data and analysis methods in an intuitive object-oriented framework</li>
</ul>
</li>
<li>Promote collaborative code development and reduce inefficient code duplication</li>
<li>Reduce barriers to entry for new students and scientists</li>
<li>Free components and flexible usage<ul>
<li>Python, Numpy, Matplotlib, Github, etc.</li>
<li>Platform-independent: desktop Mac/PC, Linux cluster</li>
<li>Command-line tool or import into code</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="example-usage">
<h2>Example usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">¶</a></h2>
<p>Initiate an FDP session:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">fdp</span>
<span class="gp">>>> </span><span class="n">nstxu</span> <span class="o">=</span> <span class="n">fdp</span><span class="o">.</span><span class="n">nstxu</span><span class="p">()</span>
</pre></div>
</div>
<p>List diagnostics:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">dir</span><span class="p">(</span><span class="n">nstxu</span><span class="o">.</span><span class="n">s141000</span><span class="p">)</span>
<span class="go">['bes', 'chers', 'equilibria', 'filterscopes', 'magnetics', 'mpts', 'mse', 'usxr']</span>
</pre></div>
</div>
<p>View logbook entries:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">nstxu</span><span class="o">.</span><span class="n">s141000</span><span class="o">.</span><span class="n">logbook</span><span class="p">()</span>
</pre></div>
</div>
<p>List signals:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">nstxu</span><span class="o">.</span><span class="n">s141000</span><span class="o">.</span><span class="n">equilibria</span><span class="o">.</span><span class="n">efit02</span><span class="o">.</span><span class="n">listSignals</span><span class="p">()</span>
<span class="go">['psirz', 'qpsi', 'shot', 'userid', 'wmhd']</span>
<span class="gp">>>> </span><span class="n">nstxu</span><span class="o">.</span><span class="n">s204620</span><span class="o">.</span><span class="n">chers</span><span class="o">.</span><span class="n">listSignals</span><span class="p">()</span>
<span class="go">['ft', 'nc', 'ti', 'valid', 'vt']</span>
</pre></div>
</div>
<p>Plot a signal:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">nstxu</span><span class="o">.</span><span class="n">s141000</span><span class="o">.</span><span class="n">mpts</span><span class="o">.</span><span class="n">te</span><span class="o">.</span><span class="n">plot</span><span class="p">()</span>
</pre></div>
</div>
<p>List methods for a signal:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">nstxu</span><span class="o">.</span><span class="n">s141000</span><span class="o">.</span><span class="n">bes</span><span class="o">.</span><span class="n">d1ch01</span><span class="o">.</span><span class="n">listMethods</span><span class="p">()</span>
<span class="go">['animate', 'fft', 'loadConfig', 'plotfft']</span>
</pre></div>
</div>
<p>Load shots for an XP:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">xp1013</span> <span class="o">=</span> <span class="n">nstxu</span><span class="o">.</span><span class="n">filter_shots</span><span class="p">(</span><span class="n">xp</span><span class="o">=</span><span class="mi">1013</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">dir</span><span class="p">(</span><span class="n">xp1013</span><span class="p">)</span>
<span class="go">['s141382', 's141383', 's141384', 's141385', 's141386', 's141387',</span>
<span class="go">'s141388', 's141389', 's141390', 's141391', 's141392', 's141393',</span>
<span class="go">'s141394', 's141395', 's141396', 's141397', 's141398', 's141399',</span>
<span class="go">'s141400', 's141401', 's141402', 's141403', 's141404', 's141405',</span>
<span class="go">'s141406', 's141407', 's141408', 's141409', 's141410', 's141411',</span>
<span class="go">'s141412', 's141413', 's141414']</span>
</pre></div>
</div>
<p>As the examples above illustrate, the FDP data object is organized like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><machine>.<shot>.<diagnostic>.<signal>.<method>
</pre></div>
</div>
<p>or, for diagnostic sub-containers like spline profiles and x-ray arrays:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><machine>.<shot>.<diagnostic>.<sub-container>.<signal>.<method>
</pre></div>
</div>
</div>
<div class="section" id="lead-developers">
<h2>Lead developers<a class="headerlink" href="#lead-developers" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>David R. Smith, U. Wisconsin-Madison</li>
<li>Kevin Tritz, The Johns Hopkins U.</li>
<li>Howard Yuh, Nova Photonics</li>
</ul>
<p>PPPL cluster support from John Schmitt</p>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p>The MIT License (MIT)</p>
<p>Copyright (c) 2015 John Schmitt, David R. Smith, Kevin Tritz, Howard Yuh</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="user_guide.html" class="btn btn-neutral float-right" title="User Guide" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Fusion Data Platform" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2015, John Schmitt, David R. Smith, Kevin Tritz, Howard Yuh.
</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:'0.0.0',
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>