-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuser_guide.html
More file actions
292 lines (188 loc) · 11.2 KB
/
user_guide.html
File metadata and controls
292 lines (188 loc) · 11.2 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
<!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>User Guide — 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="Developer Guide" href="developer_guide.html"/>
<link rel="prev" title="Introduction" href="introduction.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"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">User Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#getting-started">Getting started</a></li>
<li class="toctree-l2"><a class="reference internal" href="#usage-examples">Usage examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#initiate-a-machine-instance">Initiate a machine instance</a></li>
</ul>
</li>
</ul>
</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>User Guide</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/user_guide.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="user-guide">
<h1>User Guide<a class="headerlink" href="#user-guide" title="Permalink to this headline">¶</a></h1>
<div class="section" id="getting-started">
<h2>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
<p>This guide is for people who want to use FDP on the PPPL Linux cluster. If you wish to contribute to the FDP project as a developer, see the developer guide.</p>
<p>To use FDP on the PPPL Linux cluster, load the module nstx/fdp (you may need to unload other nstx modules):</p>
<div class="highlight-python"><div class="highlight"><pre><span></span>[sunfire06:~] % module load nstx/fdp
[sunfire06:~] % module list
Currently Loaded Modulefiles:
1) torque/2.5.2 5) idl/8.2 9) java/v1.6
2) moab/5.4.0 6) nstx/treedefs 10) nstx/mdsplus5
3) ppplcluster/1.1 7) nstx/epics 11) nstx/fdp
4) freetds/0.91 8) nstx/idldirs
</pre></div>
</div>
<p>Verify that python points to <code class="docutils literal"><span class="pre">/p/fdp/anaconda/bin/python</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span>[sunfire06:~] % which python
/p/fdp/anaconda/bin/python
</pre></div>
</div>
<p>If python does not point to <code class="docutils literal"><span class="pre">/p/fdp/anaconda/bin/python</span></code>, then PATH contains to a different python distribution. In this case, you need to modify PATH so <code class="docutils literal"><span class="pre">/p/fdp/anaconda/bin</span></code> is the first python distribution in PATH.</p>
<p>Finally, you can launch python and import the FDP package:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span>[sunfire06:~] % python
Python 2.7.10 |Anaconda 2.3.0 (64-bit)| (default, Sep 15 2015, 14:50:01)
[GCC 4.4.7 20120313 (Red Hat 4.4.7-1)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
Anaconda is brought to you by Continuum Analytics.
Please check out: http://continuum.io/thanks and https://anaconda.org
>>> import fdp
>>>
</pre></div>
</div>
<p>See Usage Examples to learn about the capabilities of FDP.</p>
</div>
<div class="section" id="usage-examples">
<h2>Usage examples<a class="headerlink" href="#usage-examples" title="Permalink to this headline">¶</a></h2>
<p>First, import the FDP module:</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>
</pre></div>
</div>
<div class="section" id="initiate-a-machine-instance">
<h3>Initiate a machine instance<a class="headerlink" href="#initiate-a-machine-instance" title="Permalink to this headline">¶</a></h3>
<p><strong>Define</strong> a NSTX machine instance:</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">fdp</span><span class="o">.</span><span class="n">nstxu</span>
</pre></div>
</div>
<p>Shots are added as referenced. For instance, without previous reference to 139980, you can enter:</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">s139980</span><span class="o">.</span><span class="n">chers</span><span class="o">.</span><span class="n">plot</span><span class="p">()</span>
</pre></div>
</div>
<p><strong>Add shots</strong> to the NSTX instance:</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">addshot</span><span class="p">(</span><span class="mi">140000</span><span class="p">)</span>
</pre></div>
</div>
<p>or a shotlist:</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">addshot</span><span class="p">([</span><span class="mi">141400</span><span class="p">,</span> <span class="mi">141401</span><span class="p">,</span> <span class="mi">141402</span><span class="p">])</span>
</pre></div>
</div>
<p>or by XP:</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">addshot</span><span class="p">(</span><span class="n">xp</span><span class="o">=</span><span class="mi">1048</span><span class="p">)</span>
</pre></div>
</div>
<p>or by date (string or int YYYYMMDD):</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">addshot</span><span class="p">(</span><span class="n">date</span><span class="o">=</span><span class="mi">20100817</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>List shots</strong> presently loaded:</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="p">)</span>
</pre></div>
</div>
<p>or:</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">listshot</span><span class="p">()</span>
</pre></div>
</div>
<p>Get a custom <strong>shotlist</strong>:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">my_shotlist</span> <span class="o">=</span> <span class="n">nstxu</span><span class="o">.</span><span class="n">get_shotlist</span><span class="p">(</span><span class="n">xp</span><span class="o">=</span><span class="mi">1032</span><span class="p">)</span> <span class="c1"># returns numpy.ndarray</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="developer_guide.html" class="btn btn-neutral float-right" title="Developer Guide" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="introduction.html" class="btn btn-neutral" title="Introduction" 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>