Installation

You can install binary packages or from source.

Binary packages (Linux)

MDP is prepackaged for:

• Debian (package python-mdp)
• Ubuntu (package python-mdp)
• Gentoo (ebuild sci-mathematics/mdp)
• Mandriva (package python-mdp)
• PCLinuxOS (package python-mdp)

Debian, Ubuntu and derivatives

Thanks to Yaroslav Halchenko, users of Debian, Ubuntu and derivatives can install the python-mdp package.

Just type:

sudo aptitude install python-mdp

Gentoo

Gentoo users can install the ebuild sci-mathematics/mdp from the science overlay.

Use your favourite package manager or, alternatively:

emerge layman
layman -L
layman -a science
emerge sci-mathematics/mdp

Binary Packages (NetBSD)

Thanks to Kamel Ibn Aziz Derouiche, NetBSD users can install the py-mdp from pkgsrc.

Binary Packages (MacOSX)

Thanks to Maximilian Nickel, Mac OS X users using MacPorts can install the packages py25-mdp-toolkit and py26-mdp-toolkit, respectively.

If you use the MacPorts system, just type:

sudo port install py25-mdp-toolkit

or:

sudo port install py26-mdp-toolkit

depending on your favoured version of Python.

If you happen to use homebrew as your OS X package manager, you will have to install from the archive or alternatively, use pip (see Python installers below).

Binary Packages (Microsoft Windows)

On Windows, the installation of the binary distribution is as easy as executing the installer and following the instructions. Get the installer here. If you run Windows Vista or Windows 7, you may need to right-click on the installer and pick Run as Administrator.

Python installers

MDP is also listed in the Python Package Index.

Users who like to install MDP using Python’s own packaging tools may want to use pip:

pip install MDP

You can even install from the git repository directly with:

pip install -e git://github.com/mdp-toolkit/mdp-toolkit#egg=MDP

Installation from source

Requirements

• Python 2.5/2.6/2.7/3.1/3.2/3.3
• NumPy ≥ 1.1

Download the latest MDP release source archive here.

If you want to live on the bleeding edge, check out the MDP git repositories. You can either browse the repository or clone the mdp-toolkit repository with:

git clone git://github.com/mdp-toolkit/mdp-toolkit

and then install as explained below.

Installation

Unpack the archive file and change to the project directory or change to the cloned git repository, and type:

python setup.py install

If you want to use MDP without installing it on the system Python path:

python setup.py install --prefix=/some_dir_in_PYTHONPATH/

Optional Libraries

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:

• SciPy ≥ 0.5.2: 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 Convolution2DNode, using the fast convolution routines in SciPy.
• Parallel Python: provide the parallel python scheduler PPScheduler in the parallel module.
• Shogun ≥ 1.0: provide the ShogunSVMClassifier node.
• LibSVM ≥ 2.91: provide the LibSVMClassifier node.
• joblib ≥ 0.4.3: provide the caching extension and the corresponding cache context manager.
• sklearn ≥ 0.6: provide wrapper nodes to several sklearn algorithms.

Python 3

MDP supports Python 3.X and Python 2.X within a single code base. Thanks to the great work by Pauli Virtanen and David Cournapeau of the NumPy developers’ team, the Python 3 compatible code is generated automatically when you install with Python 3. Note that NumPy is compatible with Python 3 since release 1.5.

Testing

If you have successfully installed MDP, you can test your installation in a Python shell as follows:

>>> import mdp
>>> mdp.test()
>>> import bimdp
>>> bimdp.test()

If some test fails, please report it to the mailing list.

License

MDP is distributed under the open source BSD license.

This file is part of Modular toolkit for Data Processing (MDP).
All the code in this package is distributed under the following conditions:

Copyright (c) 2003-2012, MDP Developers <mdp-toolkit-devel@lists.sourceforge.net>

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the Modular toolkit for Data Processing (MDP)
      nor the names of its contributors may be used to endorse or promote
      products derived from this software without specific prior written
      permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.