-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathInstallation.html
More file actions
334 lines (205 loc) · 11.5 KB
/
Copy pathInstallation.html
File metadata and controls
334 lines (205 loc) · 11.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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<!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>Install — behaviour_box 0 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="behaviour_box 0 documentation" href="index.html"/>
<link rel="next" title="Hardware" href="hardware.html"/>
<link rel="prev" title="Welcome to behaviour_box’s documentation!" 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"> behaviour_box
</a>
<div class="version">
1
</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">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Install</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#arduino">Arduino</a></li>
<li class="toctree-l2"><a class="reference internal" href="#python">Python</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#requirements">Requirements</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
<li class="toctree-l1"><a class="reference internal" href="Usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="details.html">Software Descriptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="code.html">Code Reference</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">behaviour_box</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>Install</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/Installation.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="install">
<h1>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h1>
<p>Many of the steps described here require administrator privileges on the
PC that you are using.</p>
<p>The code referred to here can be found at the following
source repository: <a class="reference external" href="https://github.com/palmerlab/behaviour_box">https://github.com/palmerlab/behaviour_box</a>.
The easiest way to get this code is to follow the link and select
the <strong>Clone or download</strong> button. The recommended way is to install
git-svn, (<a class="reference external" href="https://git-scm.com/download/win">a Windows installer can be found
here</a>) and to use the command:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">>></span> <span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">palmerlab</span><span class="o">/</span><span class="n">behaviour_box</span>
</pre></div>
</div>
<p>This will allow you to easily stay up to date with any future changes,
if you choose.</p>
<div class="section" id="arduino">
<h2>Arduino<a class="headerlink" href="#arduino" title="Permalink to this headline">¶</a></h2>
<p>To install the Arduino component you will need to have the Arduino IDE
which you can get from
<a class="reference external" href="https://www.arduino.cc/en/Main/Software">here</a>. The instructions for
how to setup Arduino on Windows can be found
<a class="reference external" href="https://www.arduino.cc/en/Guide/ArduinoUno">here</a>.</p>
<p>Once the Arduino IDE is installed open <code class="docutils literal"><span class="pre">behaviourbox\behaviourbox.ino</span></code>
in the Arduino editor. With an Arduino plugged in to the USB port you
can now upload the code using the <code class="docutils literal"><span class="pre">compile/run</span></code> button in the editor.
Note the the port that the Arduino is connected to (It’ll be labeled
<code class="docutils literal"><span class="pre">COMx</span></code> where <code class="docutils literal"><span class="pre">x</span></code> is an integer).</p>
</div>
<div class="section" id="python">
<h2>Python<a class="headerlink" href="#python" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This system was written using python 2.7 on Windows 7.
You can download python from
<a class="reference external" href="https://www.python.org/downloads/release/python-2713/">here</a></p>
</div>
<p>Because this is a command line interface it helps to have python
available from the system path, in addition you should have the python
package manager (pip) for installing the dependencies. To do all that I
would recommend following this <a class="reference external" href="https://www.howtogeek.com/197947/how-to-install-python-on-windows/">setup
guide</a>.</p>
<p>For those familiar with installing python dependencies on windows the
packages and versions used here can be found in <code class="docutils literal"><span class="pre">requirements.txt</span></code>.</p>
<p>Go to Christop Gohlke’s <a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs/">Unofficial Windows Binaries for Python
Extension Packages</a> page
and make sure to follow the instructions there for installing
numpy<a class="reference external" href="#f1">1</a>.</p>
<ul class="simple">
<li>Download additional packages from
<a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs/">http://www.lfd.uci.edu/~gohlke/pythonlibs/</a><ul>
<li><a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs/#pandas">Pandas</a></li>
<li><a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs/#sounddevice">sounddevice</a></li>
<li><strong>These smaller packages are also required and can be downloaded
from the same site.</strong> Use your browsers search to find them, they
cannot be linked to<ul>
<li>Colorama</li>
<li>Pyserial</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>In windows open an elevated command window. To do this find cmd.exe in
the start menu, right click and select run as administrator. Now cd to
the directory containing the <code class="docutils literal"><span class="pre">.whl</span></code> files that you just downloaded.
You should then be able to run <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">*.whl</span></code> to get all the
packages.</p>
<div class="section" id="requirements">
<h3>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><a class="reference external" href="https://www.microsoft.com/en-au/software-download/windows7">Windows
7</a></li>
<li><a class="reference external" href="http://pandas.pydata.org">Pandas (0.19.0)</a></li>
<li><a class="reference external" href="http://www.numpy.org/">Numpy (1.11.2+mkl)</a></li>
<li><a class="reference external" href="https://github.com/pyserial/pyserial">Pyserial (2.7)</a></li>
<li><a class="reference external" href="https://pypi.python.org/pypi/colorama">Colorama (0.3.7)</a></li>
<li><a class="reference external" href="http://python-sounddevice.readthedocs.io/en/0.3.5/">sounddevice
(0.3.5)</a></li>
<li>An Arduino running <code class="docutils literal"><span class="pre">behaviourbox.ino</span></code> connected to the same
computer</li>
</ul>
<hr class="docutils" />
<p>1 Follow specific instructions for installing Numpy+mkl. Numpy is a
python package which is designed for dealing with numerical arrays
quickly. The mkl version is simply a version of the package that has
been compiled with the intel math kernel libraries. This makes it a lot
faster than the basic version. This system doesn’t necessarily require
the speed of the mkl version, but it is a nice thing to have <a class="reference external" href="#a1">↩</a></p>
</div>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="hardware.html" class="btn btn-neutral float-right" title="Hardware" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Welcome to behaviour_box’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Andrew Micallef.
</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',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>