-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy patharchitecture-overview.html
More file actions
320 lines (208 loc) · 16 KB
/
architecture-overview.html
File metadata and controls
320 lines (208 loc) · 16 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>Event-Based Architecture — NSLS-II Software Documentation documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Cookbook (Examples)" href="cookbook/index.html" />
<link rel="prev" title="NSLS-II Software Documentation" href="index.html" />
</head>
<body class="wy-body-for-nav">
<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 current"><a class="current reference internal" href="#">Event-Based Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="cookbook/index.html">Cookbook (Examples)</a></li>
<li class="toctree-l1"><a class="reference internal" href="remote-access.html">Remote Access</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="history.html">History of Changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="conda.html">Software Deployment with Conda</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>
<li class="toctree-l1"><a class="reference internal" href="internal_index.html">Internal Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="deployment_docs.html">NSLS-II Deployment Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="meetings/index.html">Meetings</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>
<li class="toctree-l1"><a class="reference external" href="https://nsls-ii.github.io/caproto">caproto</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/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="https://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" 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>Event-Based Architecture</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/architecture-overview.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="event-based-architecture">
<span id="architecture"></span><h1>Event-Based Architecture<a class="headerlink" href="#event-based-architecture" title="Permalink to this headline">¶</a></h1>
<p>We have implemented a next-generation event-based data collection and analysis
toolchain. The event-based data model supports complex, asynchronous data
collection and enables sophisticated live, prompt, streaming, and
<em>post-facto</em> data analysis.</p>
<p>The data model is composed of four types of Documents. Each document class has
a defined, but flexible, schema. Examples are sketched below, and the precise
specifications are <a class="reference external" href="https://github.com/NSLS-II/event-model#event-model">also available</a>. The documents
themselves are mappings. We commonly represent them in JSON, as mongoDB
documents, or as Python dictionaries.</p>
<p>All of the software can be understood as tools to generate, move, and process
these documents.</p>
<a class="reference internal image-reference" href="_images/document-generation-timeline.svg"><div align="center" class="align-center"><img alt="_images/document-generation-timeline.svg" src="_images/document-generation-timeline.svg" width="100%" /></div>
</a>
<p>The scope of a “run” is left to the beamline or individual scientist. It is
quite generic: a set of Documents generated by following a given sequence of
instructions. This might encompass a single short measurement (say, “a count”)
or a multi-step procedure such as a raster scan. A run should represent a set
of individual measurements that will be collected or processed together.</p>
<p>Each run generates four types of Documents, as illustrated above.</p>
<ul>
<li><p>Start: At the beginning of a run, a Document is generated with open-ended
metadata (user name, sample information) and in general any information that
is known from the start.</p>
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'beamline_id'</span><span class="o">:</span> <span class="s1">'example'</span><span class="p">,</span>
<span class="s1">'group'</span><span class="o">:</span> <span class="s1">'DAMA'</span><span class="p">,</span>
<span class="s1">'owner'</span><span class="o">:</span> <span class="s1">'dallan'</span><span class="p">,</span>
<span class="s1">'mood'</span><span class="o">:</span> <span class="s1">'optimistic'</span><span class="p">,</span>
<span class="s1">'sample'</span><span class="o">:</span> <span class="p">{</span><span class="s1">'kind'</span><span class="o">:</span> <span class="s1">'A'</span><span class="p">,</span> <span class="s1">'protocol'</span><span class="o">:</span> <span class="s1">'B'</span><span class="p">},</span>
<span class="s1">'plan_type'</span><span class="o">:</span> <span class="s1">'AbsScan'</span><span class="p">,</span>
<span class="s1">'plan_args'</span><span class="o">:</span> <span class="p">{</span><span class="s1">'detectors'</span><span class="o">:</span> <span class="s1">'[det]'</span><span class="p">,</span>
<span class="s1">'motor'</span><span class="o">:</span> <span class="s1">'EpicsMotor(...)'</span><span class="p">,</span>
<span class="s1">'num'</span><span class="o">:</span> <span class="s1">'16'</span><span class="p">,</span>
<span class="s1">'start'</span><span class="o">:</span> <span class="s1">'-3'</span><span class="p">,</span>
<span class="s1">'stop'</span><span class="o">:</span> <span class="s1">'3'</span><span class="p">},</span>
<span class="s1">'scan_id'</span><span class="o">:</span> <span class="mi">282</span><span class="p">,</span>
<span class="s1">'time'</span><span class="o">:</span> <span class="mf">1442521005.6099606</span><span class="p">,</span>
<span class="s1">'uid'</span><span class="o">:</span> <span class="s1">'8288a9a7-c531-4ef4-966b-8c6d85d5eab4'</span><span class="p">,</span>
<span class="p">...,</span> <span class="c1">// any other user-specified fields</span>
<span class="p">}</span>
</pre></div>
</div>
</li>
<li><p>Event: Each event is a single “data point”, which may contain several
readings taken “at the same time” – the meaning of which depends on the
scientific context.</p>
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'data'</span><span class="o">:</span> <span class="p">{</span><span class="s1">'temperature'</span><span class="o">:</span> <span class="mf">5.0</span><span class="p">,</span> <span class="s1">'position'</span><span class="o">:</span> <span class="mf">3.0</span><span class="p">},</span>
<span class="s1">'timestamps'</span><span class="o">:</span> <span class="p">{</span><span class="s1">'temperature'</span><span class="o">:</span> <span class="mf">1442521007.9258342</span><span class="p">,</span> <span class="s1">'position'</span><span class="o">:</span> <span class="mf">1442521007.5029348</span><span class="p">}</span>
<span class="s1">'time'</span><span class="o">:</span> <span class="mf">1442521007.3438923</span><span class="p">,</span>
<span class="s1">'uid'</span><span class="o">:</span> <span class="p">...,</span>
<span class="s1">'descriptor'</span><span class="o">:</span> <span class="p">...,</span> <span class="c1">// uid pointing to a Descriptor Document</span>
<span class="p">}</span>
</pre></div>
</div>
</li>
<li><p>Descriptor: Each sequence of Events has an Event Descriptor with information
about what data is in the Events, such as the names, types, shapes and
hardware sources of each of the measurements. The Descriptor documents can
also contain configuration details about the hardware, such as exposure time.</p>
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'data_keys'</span><span class="o">:</span>
<span class="p">{</span><span class="s1">'temperature'</span><span class="o">:</span> <span class="p">{</span><span class="s1">'source'</span><span class="o">:</span> <span class="s1">'PV:...'</span><span class="p">,</span> <span class="s1">'dtype'</span><span class="o">:</span> <span class="s1">'number'</span><span class="p">,</span> <span class="s1">'precision'</span><span class="o">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s1">'units'</span><span class="o">:</span> <span class="s1">'K'</span><span class="p">},</span>
<span class="s1">'position'</span><span class="o">:</span> <span class="p">{</span><span class="s1">'source'</span><span class="o">:</span> <span class="s1">'PV:...'</span><span class="p">,</span> <span class="s1">'dtype'</span><span class="o">:</span> <span class="s1">'number'</span><span class="o">:</span> <span class="s1">'precision'</span><span class="o">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s1">'units'</span><span class="o">:</span> <span class="s1">'cm'</span><span class="p">}},</span>
<span class="s1">'configuration'</span><span class="o">:</span> <span class="p">{...},</span>
<span class="s1">'time'</span><span class="o">:</span> <span class="p">...,</span>
<span class="s1">'uid'</span><span class="o">:</span> <span class="p">...,</span>
<span class="s1">'start'</span><span class="o">:</span> <span class="p">...,</span> <span class="c1">// uid pointing to a Start Document</span>
<span class="p">...,</span> <span class="c1">// any other user-defined fields</span>
<span class="p">}</span>
</pre></div>
</div>
</li>
<li><p>Stop: At the end of a run, a Document is generated with information that is
only known at the end – such as whether the run terminated due to some
failure.</p>
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">'exit_status'</span><span class="o">:</span> <span class="s1">'success'</span><span class="p">,</span>
<span class="s1">'time'</span><span class="o">:</span> <span class="p">...,</span>
<span class="s1">'uid'</span><span class="o">:</span> <span class="p">...,</span>
<span class="s1">'start'</span><span class="o">:</span> <span class="p">...,</span> <span class="c1">// uid pointing to a Start Document</span>
<span class="p">...,</span> <span class="c1">// any other user-defined fields</span>
<span class="p">}</span>
</pre></div>
</div>
</li>
</ul>
<p>The precise schemas for these documents are provided as jsonschema documents
in <a class="reference external" href="https://github.com/NSLS-II/event-model#event-model">this repository</a>.</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cookbook/index.html" class="btn btn-neutral float-right" title="Cookbook (Examples)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="NSLS-II Software Documentation" accesskey="p" rel="prev"><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/rtfd/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">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>