-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstallation.html
217 lines (202 loc) · 13.1 KB
/
installation.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Installation — wonambi 7.11 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="shortcut icon" href="_static/wonambi.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<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/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Tutorial / Analysis" href="analysis/index.html" />
<link rel="prev" title="WONAMBI" href="introduction.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"> wonambi
<img src="_static/wonambi.png" class="logo" alt="Logo"/>
</a>
<div class="version">
7.11
</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="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">WONAMBI</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#run-it">Run it!</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#documentation">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#change-log">Change Log</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#optional-requirements">Optional Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#status">Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#license">License</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#linux-mac-os-x">Linux / Mac OS X</a></li>
<li class="toctree-l2"><a class="reference internal" href="#windows">Windows</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="analysis/index.html">Tutorial / Analysis</a><ul>
<li class="toctree-l2"><a class="reference internal" href="analysis/tutorial.html">Get Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="analysis/spectrum.html">Frequency Domain</a></li>
<li class="toctree-l2"><a class="reference internal" href="analysis/plot3d.html">Plot 3D images</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cmd.html">Command Line</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#wonambi">wonambi</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#won-convert">won_convert</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gui/index.html">Graphical User Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gui/open.html">Open Dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/labels.html">Edit Labels</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/channels.html">Plot Channels</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/traces.html">Navigation</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/notes.html">Annotations</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/detect.html">Event detection</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/methods.html">Detection methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/analysis.html">Analysis console</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/screenshot.html">Screenshot</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/wonambi.html">Modules, classes, functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/wonambi.html#subpackages">Subpackages</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/wonambi.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="testing.html#prepare-test-environment">Prepare Test Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#get-files">1. Get Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#run-the-tests">2. Run the Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#coverage">3. Coverage</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#documentation">4. Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#release">5. Release</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#tips-and-tricks">Tips and Tricks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change Log</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-7">Version 7</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-6">Version 6</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-5">Version 5</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-4">Version 4</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-3">Version 3</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-2">Version 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1">Version 1</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">TODO</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">wonambi</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Installation</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h1>
<p>wonambi is pure python, so it can be installed on every platform if you have the correct dependencies.
Make sure if you have at least python 3.6 installed.
Then you can install it, by typing:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">wonambi</span></code></p>
<p>and to run it:</p>
<p><code class="docutils literal notranslate"><span class="pre">wonambi</span></code></p>
<p>To install the correct dependencies, follow the platform-specific instructions below.</p>
<section id="linux-mac-os-x">
<h2>Linux / Mac OS X<a class="headerlink" href="#linux-mac-os-x" title="Permalink to this heading"></a></h2>
<p>Make sure that you’re running the latest version of pip:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">--upgrade</span> <span class="pre">pip</span></code></p>
<p>Then you can install all the dependencies with:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">numpy</span> <span class="pre">scipy</span></code></p>
<p>If you want a GUI, also install:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">pyqt5</span></code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you receive an error regarding permissions (f.e. if you see <code class="docutils literal notranslate"><span class="pre">permission</span> <span class="pre">denied</span></code>), you can install wonambi as local user:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">--user</span> <span class="pre">wonambi</span></code></p>
<p>Then you need to run:</p>
<p><code class="docutils literal notranslate"><span class="pre">export</span> <span class="pre">PATH=~/.local/bin:$PATH</span></code></p>
</div>
</section>
<section id="windows">
<h2>Windows<a class="headerlink" href="#windows" title="Permalink to this heading"></a></h2>
<p>Unfortunately scipy cannot be easily be installed on Windows at the moment.
There are two ways to get around it:</p>
<section id="wheels">
<h3>Wheels<a class="headerlink" href="#wheels" title="Permalink to this heading"></a></h3>
<p>If you have the official python binaries, you can should make sure that you’re running the latest version of pip:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">--upgrade</span> <span class="pre">pip</span></code></p>
<p>then download the wheels (precompiled packages) for <a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy">numpy</a> and <a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs/#scipy">scipy</a>.</p>
<p>If you want a GUI, also install:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">pyqt5</span></code></p>
</section>
<section id="anaconda">
<h3>Anaconda<a class="headerlink" href="#anaconda" title="Permalink to this heading"></a></h3>
<p>You can download and install the 64-bit installer from <a class="reference external" href="http://conda.pydata.org/miniconda.html">anaconda</a>.
Then make sure that you’re using the latest version:</p>
<p><code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">update</span> <span class="pre">conda</span></code></p>
<p>and install numpy and scipy:</p>
<p><code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">install</span> <span class="pre">numpy</span> <span class="pre">scipy</span></code></p>
<p>If you want a GUI, also install:</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">pyqt5</span></code></p>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="introduction.html" class="btn btn-neutral float-left" title="WONAMBI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="analysis/index.html" class="btn btn-neutral float-right" title="Tutorial / Analysis" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2013-2022, Gio Piantoni / Jordan O'Byrne.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(false);
});
</script>
</body>
</html>