-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathinstall.html
184 lines (170 loc) · 10.2 KB
/
install.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Installation — Modular toolkit for Data Processing (MDP)</title>
<link rel="stylesheet" href="_static/mdp.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '3.6',
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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Documentation" href="documentation.html" />
<link rel="prev" title="<no title>" href="index.html" />
<meta name="viewport" content="width=740" />
</head>
<body>
<div id="header">
<table width="100%">
<tr>
<td class="td_header_left">
<a href="https://mdp-toolkit.github.io">
Modular toolkit for<br />Data Processing
</a>
</td>
<td class="td_header_right">
<a href="examples/logo/logo_animation.html">
<img src="_static/logo.png" alt="MDP logo"
title="click to see the animated logo!" class="img_header"/>
</a>
</td>
</tr>
</table>
<div class="clear"></div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div class="navigation_title"><a href="index.html">Home</a></div>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#pip-windows-macosx-linux">pip (Windows, MacOSX, Linux)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#binary-packages-linux">Binary packages (Linux)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#install-the-development-version">Install the development version</a></li>
<li class="toctree-l2"><a class="reference internal" href="#optional-libraries">Optional Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="#testing">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_cite_mdp.html">How to cite MDP</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<span class="target" id="install"></span><div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
<p>You can install using <a class="reference internal" href="#pip"><span class="std std-ref">pip (Windows, MacOSX, Linux)</span></a>, <a class="reference internal" href="#binary-packages"><span class="std std-ref">binary packages</span></a> or
from <a class="reference internal" href="#install-from-source"><span class="std std-ref">source</span></a>.</p>
<div class="section" id="pip-windows-macosx-linux">
<span id="pip"></span><h2>pip (Windows, MacOSX, Linux)<a class="headerlink" href="#pip-windows-macosx-linux" title="Permalink to this headline">¶</a></h2>
<p>MDP is listed in the <a class="reference external" href="http://pypi.python.org/pypi/MDP">Python Package Index</a> and can be
installed with <code class="docutils literal"><span class="pre">pip</span></code>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">mdp</span>
</pre></div>
</div>
</div>
<div class="section" id="binary-packages-linux">
<span id="binary-packages"></span><h2>Binary packages (Linux)<a class="headerlink" href="#binary-packages-linux" title="Permalink to this headline">¶</a></h2>
<p>Users of some Linux distributions (Debian, Ubuntu, Fedora, …) can install the <code class="docutils literal"><span class="pre">python3-mdp</span></code> package using
the distribution package manager.</p>
</div>
<div class="section" id="install-the-development-version">
<span id="install-from-source"></span><h2>Install the development version<a class="headerlink" href="#install-the-development-version" title="Permalink to this headline">¶</a></h2>
<p>If you want to live on the bleeding edge, check out the MDP git repositories.
You can either <a class="reference external" href="https://github.com/mdp-toolkit/mdp-toolkit">browse the repository</a>
or directly install the development version from the repository with:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">git</span><span class="o">+</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">mdp</span><span class="o">-</span><span class="n">toolkit</span><span class="o">/</span><span class="n">mdp</span><span class="o">-</span><span class="n">toolkit</span><span class="o">.</span><span class="n">git</span>
</pre></div>
</div>
</div>
<div class="section" id="optional-libraries">
<h2>Optional Libraries<a class="headerlink" href="#optional-libraries" title="Permalink to this headline">¶</a></h2>
<p>MDP can make use of several additional libraries if they are installed on your
system. They are not required for using MDP, but may give more
functionality. Here a list of optional libraries and the corresponding
additional features in MDP:</p>
<ul class="simple">
<li><a class="reference external" href="http://www.scipy.org/">SciPy</a> : Use the fast and
efficient LAPACK wrapper for the symmetrical eigensolver, used
interally by many nodes; use the fast FFT routines in some nodes;
provide the <code class="docutils literal"><span class="pre">Convolution2DNode</span></code>, using the fast convolution routines
in SciPy.</li>
<li><a class="reference external" href="http://www.csie.ntu.edu.tw/~cjlin/libsvm/">LibSVM</a> :
provide the <code class="docutils literal"><span class="pre">LibSVMClassifier</span></code> node.</li>
<li><a class="reference external" href="http://packages.python.org/joblib/">joblib</a> : provide the
<code class="docutils literal"><span class="pre">caching</span></code> extension and the corresponding <code class="docutils literal"><span class="pre">cache</span></code> context
manager.</li>
<li><a class="reference external" href="http://scikit-learn.org/stable/">scikit-learn</a> : provide
wrapper nodes to several sklearn algorithms.</li>
</ul>
<p>You can install all the additional libraries with pip:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">scipy</span> <span class="n">scikit</span><span class="o">-</span><span class="n">learn</span> <span class="n">joblib</span> <span class="n">libsvm</span>
</pre></div>
</div>
</div>
<div class="section" id="testing">
<h2>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h2>
<p>If you have successfully installed MDP, you can test your installation in a
Python shell as follows:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">mdp</span>
<span class="gp">>>> </span><span class="n">mdp</span><span class="o">.</span><span class="n">test</span><span class="p">()</span>
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">bimdp</span>
<span class="gp">>>> </span><span class="n">bimdp</span><span class="o">.</span><span class="n">test</span><span class="p">()</span>
</pre></div>
</div>
<p>Note that you will need to install <a class="reference external" href="http://pytest.org">pytest</a> to run the tests.</p>
<p>If some test fails, please file a <a class="reference external" href="https://github.com/mdp-toolkit/mdp-toolkit/issues">bug report</a>.
Optionally, report it to the <a class="reference external" href="https://mail.python.org/mm3/mailman3/lists/mdp-toolkit.python.org/">mailing list</a>.</p>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p>MDP is distributed under the open source <a class="reference external" href="https://github.com/mdp-toolkit/mdp-toolkit/blob/master/COPYRIGHT">BSD license</a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
<hr />
<table>
<tr>
<td class="footer-left">
<a href="https://github.com/mdp-toolkit/mdp-toolkit">
<img src="https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png"
width="60" height="15" border="0"/> </a>
</td>
<td class="footer-center">
Last updated on
2020-12-16 6:49:02 PM Coordinated Universal Time
</td>
<td class="footer-right">
<form class="search" action="search.html" method="get">
<input type="submit" value="Search" />
<input type="text" name="q" size="18" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</td>
</table>
</div>
</body>
</html>