-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
309 lines (193 loc) · 14 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
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
<!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>the labscript suite — labscript suite | the labscript suite</title>
<link rel="shortcut icon" href="_static/labscript.ico"/>
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script 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/custom.css" type="text/css" />
<link rel="index" title="Index" href="genindex/" />
<link rel="search" title="Search" href="search/" />
<link rel="next" title="Installing the labscript suite" href="installation/" />
</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="#" class="icon icon-home"> the labscript suite
<img src="_static/labscript-suite-rectangular-transparent_276x140.svg" class="logo" alt="Logo"/>
</a>
<div class="version">
3.0.0rc2.dev1+gfba5b50
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search/" 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">
<p class="caption"><span class="caption-text">DOCUMENTATION</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation/">Installing the <em>labscript suite</em></a></li>
<li class="toctree-l1"><a class="reference internal" href="changes/">Recent changes to the <em>labscript suite</em></a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing/">Contributing to the <em>labscript suite</em></a></li>
<li class="toctree-l1"><a class="reference internal" href="archive/">BitBucket archive</a></li>
</ul>
<p class="caption"><span class="caption-text">FURTHER DOCUMENTATION</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="components/"><em>labscript suite</em> components</a></li>
</ul>
<p class="caption"><span class="caption-text">LINKS</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="http://labscriptsuite.org">Home Page</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/labscript-suite/labscript-suite">Source Code</a></li>
<li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/labscript-suite/">PyPI</a></li>
<li class="toctree-l1"><a class="reference external" href="https://anaconda.org/labscript-suite/labscript-suite">Anaconda Cloud</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="#">the labscript suite</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="#">Docs</a> »</li>
<li>the <em>labscript suite</em></li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.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="the-labscript-suite">
<h1>the <em>labscript suite</em><a class="headerlink" href="#the-labscript-suite" title="Permalink to this headline">¶</a></h1>
<div class="section" id="experiment-control-and-automation-system">
<h2>Experiment control and automation system<a class="headerlink" href="#experiment-control-and-automation-system" title="Permalink to this headline">¶</a></h2>
<hr class="docutils" />
<p>The <em>labscript suite</em> is a powerful and extensible framework for experiment <a class="reference external" href="https://github.com/labscript-suite/labscript">composition</a>, <a class="reference external" href="https://github.com/labscript-suite/runmanager">control</a>, <a class="reference external" href="https://github.com/labscript-suite/blacs">execution</a>, and <a class="reference external" href="https://github.com/labscript-suite/lyse">analysis</a>. Developed for quantum science and quantum engineering; deployable in laboratory and in-field devices. Also applicable to optics, microscopy, materials engineering, biophysics, and any application predicated on the repetition of parameterised, hardware-timed experiments.</p>
<div class="section" id="features">
<h3>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p>Flexible and automated oversight of heterogeneous hardware.</p></li>
<li><p>The most mature and widely used open-source control system in quantum science.</p></li>
<li><p>Multiple analysis-based feedback modes.</p></li>
<li><p>Extensible plugin architecture (e.g. machine learning online optimisation).</p></li>
<li><p>Readily integrates with other software, including image acquisition, analysis, and even other control systems.</p></li>
<li><p>Compose experiments as human-readable Python code, leveraging modularity, revision control and re-use.</p></li>
<li><p>Dynamic visualisation of experiment composition and results.</p></li>
<li><p>Remote operation: different modules can run on physically separate hosts / single modules can be run on multiple hosts (including hardware supervisor, <a class="reference external" href="https://github.com/labscript-suite/blacs">blacs</a>).</p></li>
<li><p>Auto-generating user-interfaces.</p></li>
<li><p>High-level scripting: user-interface interaction can be programatically synthesised.</p></li>
</ul>
</div>
<div class="section" id="citing-the-labscript-suite">
<h3>Citing the <em>labscript suite</em><a class="headerlink" href="#citing-the-labscript-suite" title="Permalink to this headline">¶</a></h3>
<p>If you use the <em>labscript suite</em> to control your experiment or perform analysis, please cite one or more of the following publications:</p>
<details>
<summary>P. T. Starkey, <em><a href="https://doi.org/10.26180/5d1db8ffe29ef">A software framework for control and automation of precisely timed experiments</a>.</em> PhD thesis, Monash University (2019).</summary><div class="highlight-bibtex notranslate"><div class="highlight"><pre><span></span><span class="nc">@phdthesis</span><span class="p">{</span><span class="nl">starkey_phd_2019</span><span class="p">,</span>
<span class="na">title</span> <span class="p">=</span> <span class="s">{State-dependent forces in cold quantum gases}</span><span class="p">,</span>
<span class="na">author</span> <span class="p">=</span> <span class="s">{Starkey, P. T.}</span><span class="p">,</span>
<span class="na">year</span> <span class="p">=</span> <span class="s">{2019}</span><span class="p">,</span>
<span class="na">url</span> <span class="p">=</span> <span class="s">{https://doi.org/10.26180/5d1db8ffe29ef}</span><span class="p">,</span>
<span class="na">doi</span> <span class="p">=</span> <span class="s">{10.26180/5d1db8ffe29ef}</span><span class="p">,</span>
<span class="na">school</span> <span class="p">=</span> <span class="s">{Monash University}</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
</details>
<details>
<summary>C. J. Billington, <em><a href="https://doi.org/10.26180/5bd68acaf0696">State-dependent forces in cold quantum gases</a>.</em> PhD thesis, Monash University (2018).</summary><div class="highlight-bibtex notranslate"><div class="highlight"><pre><span></span><span class="nc">@phdthesis</span><span class="p">{</span><span class="nl">billington_phd_2018</span><span class="p">,</span>
<span class="na">title</span> <span class="p">=</span> <span class="s">{State-dependent forces in cold quantum gases}</span><span class="p">,</span>
<span class="na">author</span> <span class="p">=</span> <span class="s">{Billington, C. J.}</span><span class="p">,</span>
<span class="na">year</span> <span class="p">=</span> <span class="s">{2018}</span><span class="p">,</span>
<span class="na">url</span> <span class="p">=</span> <span class="s">{https://doi.org/10.26180/5bd68acaf0696}</span><span class="p">,</span>
<span class="na">doi</span> <span class="p">=</span> <span class="s">{10.26180/5bd68acaf0696}</span><span class="p">,</span>
<span class="na">school</span> <span class="p">=</span> <span class="s">{Monash University}</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
</details>
<details>
<summary><em><a href="https://doi.org/10.1063/1.4817213">A scripted control system for autonomous hardware-timed experiments</a>,</em> Review of Scientific Instruments <b>84</b>, 085111 (2013). arXiv:<a href="http://arxiv.org/abs/1303.0080">1303.0080</a>.</summary><div class="highlight-bibtex notranslate"><div class="highlight"><pre><span></span><span class="nc">@article</span><span class="p">{</span><span class="nl">labscript_2013</span><span class="p">,</span>
<span class="na">author</span> <span class="p">=</span> <span class="s">{Starkey, P. T. and Billington, C. J. and Johnstone, S. P. and</span>
<span class="s"> Jasperse, M. and Helmerson, K. and Turner, L. D. and Anderson, R. P.}</span><span class="p">,</span>
<span class="na">title</span> <span class="p">=</span> <span class="s">{A scripted control system for autonomous hardware-timed experiments}</span><span class="p">,</span>
<span class="na">journal</span> <span class="p">=</span> <span class="s">{Review of Scientific Instruments}</span><span class="p">,</span>
<span class="na">volume</span> <span class="p">=</span> <span class="s">{84}</span><span class="p">,</span>
<span class="na">number</span> <span class="p">=</span> <span class="s">{8}</span><span class="p">,</span>
<span class="na">pages</span> <span class="p">=</span> <span class="s">{085111}</span><span class="p">,</span>
<span class="na">year</span> <span class="p">=</span> <span class="s">{2013}</span><span class="p">,</span>
<span class="na">doi</span> <span class="p">=</span> <span class="s">{10.1063/1.4817213}</span><span class="p">,</span>
<span class="na">url</span> <span class="p">=</span> <span class="s">{https://doi.org/10.1063/1.4817213}</span><span class="p">,</span>
<span class="na">eprint</span> <span class="p">=</span> <span class="s">{https://doi.org/10.1063/1.4817213}</span>
<span class="p">}</span>
</pre></div>
</div>
</details><div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>discussion on python vs. conda and regular vs. developer install</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="installation/#id1"><em>original entry</em></a> is located in /home/runner/work/labscript-suite/labscript-suite/docs/source/installation/index.rst, line 4.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>Development versions will be suffixed with <code class="code docutils literal notranslate"><span class="pre">devN</span></code>, i.e.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp gp-VirtualEnv">(.venv)</span> <span class="go">C:\Users\wkheisenberg\labscript-suite> pip install -i https://test.pypi.org/simple runmanager==2.6.0dev3</span>
</pre></div>
</div>
</div>
<p class="todo-source">(The <a class="reference internal" href="installation/regular-pypi/#id1"><em>original entry</em></a> is located in /home/runner/work/labscript-suite/labscript-suite/docs/source/installation/regular-pypi.rst, line 126.)</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="installation/" class="btn btn-neutral float-right" title="Installing the labscript suite" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, labscript suite
</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>