-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
185 lines (159 loc) · 7.58 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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Neurobooth-os — neurobooth-os documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="#">
neurobooth-os</a>
<span class="navbar-text navbar-version pull-left"><b>0.1.dev0</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li><a href="api.html">API</a></li>
<li><a href="https://github.com/neurobooth/neurobooth-os">GitHub</a></li>
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="#">Site <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"></ul>
</li>
<li class="dropdown">
<a role="button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page <b class="caret"></b></a>
<ul class="dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">Neurobooth-os</a></li>
<li><a class="reference internal" href="#installations">Installations</a></li>
<li><a class="reference internal" href="#setup">Setup</a></li>
<li><a class="reference internal" href="#run">Run</a></li>
</ul>
</ul>
</li>
<li class="hidden-sm">
<div id="sourcelink">
<a href="_sources/index.rst.txt"
rel="nofollow">Source</a>
</div></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<section id="neurobooth-os">
<h1>Neurobooth-os<a class="headerlink" href="#neurobooth-os" title="Permalink to this headline">¶</a></h1>
<p>Neurobooth-os is a python package to initialize, synchronize and record
behavioral and physiological data streams from wearables, D-/RGB cameras, eye tracker,
ECG, mouse and microphone in a booth.</p>
</section>
<section id="installations">
<h1>Installations<a class="headerlink" href="#installations" title="Permalink to this headline">¶</a></h1>
<p>We recommend the Anaconda Python distribution. To install neurobooth-os, simply do:</p>
<p>$ pip install -e git+https://github.com/neurobooth/neurobooth-os.git#egg=neurobooth_os</p>
<p>and it will install neurobooth-os along with the dependencies which are not already installed.</p>
<p>To check if everything worked fine, you can do:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python -c 'import neurobooth_os'
</pre></div>
</div>
<p>and it should not give any error messages.</p>
<p>Install Pylink running:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install --index-url=https://pypi.sr-support.com sr-research-pylink
</pre></div>
</div>
</section>
<section id="setup">
<h1>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h1>
<p>It requires a postgreSQL database running on a server. Connection is established with the function
<em class="xref py py-obj">neurobooth_os.iout.metadator.get_conn()</em>. Currently, as specified in
<em class="xref py py-obj">neurobooth_os_secrets</em> the local IP is 192.168.100.1, and remotely it connects to
<em class="xref py py-obj">neurodoor.nmr.mgh.harvard.edu</em> using the private key in ‘~/.ssh/id_rsa’.</p>
<p>To setup a private key, first activate the VPN (partner’s virtual private network), then run in
the terminal:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ssh-keygen
$ ssh-copy-id userID@neurodoor.nmr.mgh.harvard.edu
</pre></div>
</div>
<p>Next, set up secrets and configuration files. In a python session, run:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ import neurobooth_os.secrets_info
$ import neurobooth_os.config
</pre></div>
</div>
<p>This will generate <em class="xref py py-obj">neurobooth_os_secrets</em> and <em class="xref py py-obj">neurobooth_os_config</em>.
Edit them with your info and path to folders.</p>
</section>
<section id="run">
<h1>Run<a class="headerlink" href="#run" title="Permalink to this headline">¶</a></h1>
<p>The program runs on 3 different computers and the starting point is
<code class="docutils literal notranslate"><span class="pre">gui.py</span></code>. The computers are:</p>
<ul class="simple">
<li><p>CTR (control) computer: This computer hosts the GUI and relays commands</p></li>
</ul>
<p>to the other computers to start recording from the Neurobooth devices
and presenting stimuli. The lab recorder software is on this computer.</p>
<ul class="simple">
<li><p>STM (stimulus) computer: This computer runs the tasks using <code class="docutils literal notranslate"><span class="pre">psychopy</span></code>.</p></li>
<li><p>ACQ (acquisition) computer: This computer acquires data.</p></li>
</ul>
<p>Each computer has a server that listens for communication from the other
computers in the form of string messages. CTR and STM computer communicate
with the database.</p>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>
© Copyright 2021, Neurobooth Developers.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.0.2.<br/>
</p>
</div>
</footer>
</body>
</html>