SMALLbox

h1. Installation Guide

_note: this wiki page is being updated. Last changes: 19/06/2012_

h2. Overview

Before you install SMALLbox you need to have MATLAB correctly installed and to make sure the *mex* is working correctly. 

h2. Matlab and MEX setup

After installing MATLAB, you need to make sure you are able to build MEX-files. To do this you need a working compiler. 

h3. Mac OS X

On OS X you need to install Xcode in order to have a C compiler. 

h3. Linux

If you're using Linux, Matlab will use gcc, which is included in most Linux distributions.

h3. Windows

h3. Testing mex

h2. SMALLBox

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*.

Please note that within the toolboxes are several MEX components that must be compiled. If you do not already have MEX setup, run "mex -setup" or type "help mex" in the MATLAB command prompt.

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.