InstallationGuide » History » Version 11

Luis Figueira, 2012-06-26 11:42 AM
fixed formatting

1 1 Luis Figueira
h1. Installation Guide
2 1 Luis Figueira
3 10 Luis Figueira
{{>toc}}
4 10 Luis Figueira
5 11 Luis Figueira
*Notice: please read the "Known Issues":https://code.soundsoftware.ac.uk/projects/smallbox/wiki/Version20KnownIssues page before installing SMALLbox.*
6 1 Luis Figueira
7 1 Luis Figueira
h2. Overview
8 1 Luis Figueira
9 4 Luis Figueira
Before you install SMALLbox you need to have MATLAB correctly installed and to make sure *mex* is working correctly. 
10 1 Luis Figueira
11 5 Luis Figueira
h2. MEX setup
12 1 Luis Figueira
13 6 Boris Mailhe
After installing MATLAB, you need to make sure you are able to build MEX-files. To do this you need a working C compiler. 
14 3 Luis Figueira
15 3 Luis Figueira
h3. Mac OS X
16 3 Luis Figueira
17 6 Boris Mailhe
On OS X you can get a C compiler with Xcode. 
18 3 Luis Figueira
19 3 Luis Figueira
h3. Linux
20 3 Luis Figueira
21 5 Luis Figueira
If you're using Linux, MATLAB will use gcc, which is included in most Linux distributions.
22 1 Luis Figueira
23 1 Luis Figueira
h3. Windows
24 5 Luis Figueira
25 5 Luis Figueira
h4. 32-bit
26 5 Luis Figueira
27 5 Luis Figueira
On 32-bit versions of Microsoft Windows, MATLAB provides a C compiler, Lcc. 
28 5 Luis Figueira
29 5 Luis Figueira
h4. 64-bit
30 1 Luis Figueira
31 7 Luis Figueira
Depending on your version of MATLAB, different configurations may apply. Please follow the official Mathworks documentation on how to get mex to work in Windows 64-bit.
32 7 Luis Figueira
33 7 Luis Figueira
* "Matlab R2012a":http://www.mathworks.co.uk/support/compilers/R2012a/win64.html
34 7 Luis Figueira
* "Matlab R2011b":http://www.mathworks.co.uk/support/compilers/R2011b/win64.html 
35 7 Luis Figueira
* "Matlab R2011a":http://www.mathworks.co.uk/support/compilers/R2011a/win64.html 
36 8 Luis Figueira
* "Matlab R2010b":http://www.mathworks.co.uk/support/compilers/R2010b/win64.html#matlab
37 8 Luis Figueira
* "Matlab R2010a":http://www.mathworks.co.uk/support/compilers/R2010a/win64.html
38 7 Luis Figueira
39 1 Luis Figueira
40 6 Boris Mailhe
h3. Configuring Matlab for MEX-files
41 1 Luis Figueira
42 6 Boris Mailhe
If you are using the MEX compiler for the first time, run "mex -setup" or type "help mex" in the MATLAB command prompt before trying to install SMALLbox.
43 6 Boris Mailhe
44 6 Boris Mailhe
h2. SMALLbox
45 6 Boris Mailhe
46 1 Luis Figueira
To install the toolbox run the script SMALLboxSetup.m from the MATLAB command prompt and follow the instructions. @SmallboxSetup.m@ is in the root SMALLbox directory. The SMALLbox installation involves the automatic download of several existing toolboxes. Due to the automatic download of toolboxes you must have an *active internet connection*.
47 1 Luis Figueira
48 1 Luis Figueira
Once installed, there are two optional demo functions that can be run. Further information can be found in the README.txt in the main SMALLbox directory.