-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathanalysis-quick-start.html
299 lines (196 loc) · 10.7 KB
/
analysis-quick-start.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
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
<!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>Data Analysis Quick Start — NSLS-II Software Documentation documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="NSLS-II Software Documentation documentation" href="index.html"/>
<link rel="next" title="Examples" href="examples/index.html"/>
<link rel="prev" title="Data Collection Quick Start" href="collection-quick-start.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"> NSLS-II Software Documentation
</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="architecture-overview.html">Event-Based Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="collection-quick-start.html">Data Collection Quick Start</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Data Analysis Quick Start</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#option-1-at-the-beamline">Option 1: At the Beamline</a></li>
<li class="toctree-l2"><a class="reference internal" href="#option-2-remotely">Option 2: Remotely</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/index.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="sandbox.html">Sandbox</a></li>
<li class="toctree-l1"><a class="reference internal" href="fresh-installation.html">Installation at a Beamline</a></li>
<li class="toctree-l1"><a class="reference internal" href="resources.html">Recommended Resources</a></li>
</ul>
<p class="caption"><span class="caption-text">Data Collection</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://nsls-ii.github.io/bluesky">bluesky</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nsls-ii.github.io/ophyd">ophyd</a></li>
</ul>
<p class="caption"><span class="caption-text">Data Access and Management</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://nsls-ii.github.io/databroker">databroker</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nsls-ii.github.io/amostra">amostra</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nsls-ii.github.io/datamuxer">datamuxer</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nsls-ii.github.io/suitcase">suitcase</a></li>
</ul>
<p class="caption"><span class="caption-text">Data Analysis</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="http://scikit-beam.github.io/scikit-beam">scikit-beam</a></li>
</ul>
<p class="caption"><span class="caption-text">GitHub Links</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://github.com/NSLS-II/">NSLS-II Repositories</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/NSLS-II/wishlist/issues">Wish List</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/NSLS-II/Bug-Reports/issues">Bug Reports</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">NSLS-II Software Documentation</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>Data Analysis Quick Start</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/analysis-quick-start.rst.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="data-analysis-quick-start">
<h1>Data Analysis Quick Start<a class="headerlink" href="#data-analysis-quick-start" title="Permalink to this headline">¶</a></h1>
<p>You can perform data analysis remotely, off-site, or at a beamline computer.
Accordingly, there are two parts to this guide.</p>
<div class="section" id="option-1-at-the-beamline">
<h2>Option 1: At the Beamline<a class="headerlink" href="#option-1-at-the-beamline" title="Permalink to this headline">¶</a></h2>
<ol class="arabic">
<li><p class="first">Log in to your controls account. If this is your first time, execute this
command to add a line to your <code class="docutils literal"><span class="pre">.bashrc</span></code> file.:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="nb">echo</span> <span class="s2">"export PATH=/opt/conda/bin:\$PATH"</span> >> ~/.bashrc
<span class="nb">source</span> ~/.bashrc
</pre></div>
</div>
</li>
<li><p class="first">Activate the <code class="docutils literal"><span class="pre">analysis</span></code> conda environment.:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="nb">source</span> activate analysis
</pre></div>
</div>
<p>This command makes the data collection software available by adding it
your UNIX <code class="docutils literal"><span class="pre">$PATH</span></code>.</p>
</li>
<li><p class="first">Start IPython.:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>ipython
</pre></div>
</div>
<p>or, alternatively, IPython notebook:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>ipython notebook
</pre></div>
</div>
</li>
</ol>
<p>You are ready to work. See the
<a class="reference external" href="https://nsls-ii.github.io/dataportal">dataportal documentation</a>
to look up scans and retrieve data. See the
<a class="reference external" href="https://scikit-xray.github.io/scikit-xray">scikit-xray documentation</a>
for some Python tools for X-ray data analysis.</p>
</div>
<div class="section" id="option-2-remotely">
<h2>Option 2: Remotely<a class="headerlink" href="#option-2-remotely" title="Permalink to this headline">¶</a></h2>
<p>You need access to the BNL campus network, via a wired connection or VPN. You
also need a controls account. (Contact one of the NSLS-II sysadmins.)</p>
<ol class="arabic">
<li><p class="first">Go to <a class="reference external" href="https://notebook.nsls2.bnl.gov">https://notebook.nsls2.bnl.gov</a>.
Remember, if you are not connected to the campus network, that link will not
work.</p>
</li>
<li><p class="first">You will be shown a login prompt. Enter your <em>controls</em> account and
password.</p>
<img alt="_images/jupyterhub-login.png" class="align-center" src="_images/jupyterhub-login.png" />
</li>
<li><p class="first">Choose a beamline from drop-down menu at the top right of the page.</p>
<img alt="_images/jupyterhub-kernel-menu.png" class="align-center" src="_images/jupyterhub-kernel-menu.png" />
</li>
</ol>
<p>This will open a new IPython notebook with all the software ready to use. It
has fast access to the beamline’s data.</p>
<blockquote>
<div><img alt="_images/jupyterhub-blank-nb.png" class="align-center" src="_images/jupyterhub-blank-nb.png" />
</div></blockquote>
<p>You are ready to work. See the
<a class="reference external" href="https://nsls-ii.github.io/dataportal">dataportal documentation</a>
to look up scans and retrieve data. See the
<a class="reference external" href="https://scikit-xray.github.io/scikit-xray">scikit-xray documentation</a>
for some Python tools for X-ray data analysis.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="examples/index.html" class="btn btn-neutral float-right" title="Examples" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="collection-quick-start.html" class="btn btn-neutral" title="Data Collection Quick Start" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2015 Brookhaven National Lab.
</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>