Installation

Introduction

This page will walk you through the SUMO Toolbox installation. Please refer to the system requirements first. See the downloading section on how to download the toolbox.

Quick start

Quick and dirty instructions:

1. Unzip the toolbox zip file, it will create a directory (= the toolbox installation directory)
2. Unzip the activation zip file in the toolbox directory (this file was mailed to you after you registered)
3. Start Matlab
4. Go to the toolbox directory
5. Run 'startup'
6. Run 'go'

Basic Installation

Toolbox

Unzip the toolbox zip file to a directory somewhere on your harddisk, the full path of the SUMO Toolbox (including installation directory) will be referred to as the toolbox root directory. Note that you do not have to put the toolbox in the Matlab installation directory, we actually advise against it since it can cause confusing errors.

• <installation directory>
  • bin/ : binaries, executable scripts, ...
  • config/ : configuration files, location of default.xml
  • config/demo : a couple of demo configuration files that may help you
  • doc/ : some documentation
  • doc/apidoc : Javadoc and other api docs
  • lib/ : required libraries (eg: dom4j)
  • output/ : some output may be placed here (e.g., a global log file)
  • src/ : all source code
  • examples/ : project directories of different examples (you can test with these problems and use them as an example to add your own)

Activation file

Once you have received the activation file simply unzip it in your toolbox root directory. So place the zip file in the toolbox directory and unzip it there, it should place all files in the correct places (see also the README file in the activation zip). Make sure you restart Matlab (if it was running) after you have done this.

Extension pack

There are a number of third party tools and modeling libraries that the SUMO Toolbox can use but that we cannot distribute together with the toolbox. These have been bundeled in an extension pack. To install the extension pack, download the zip file, and unzip it in your toolbox root directory. The files should be placed in the correct directories. Simply re-run 'startup' to make Matlab aware of the new files.

If you download and/or use these files please respect their licenses (found in doc/licenses), THIS IS YOUR RESPONSIBILITY !!!.

Setup

Setting up the toolbox is very easy. Start Matlab, navigate to the toolbox installation directory and run 'startup'.

Side Note: if you dont want to run the toolbox in its own directory you will need to make sure Matlab will be able to find the source files for the toolbox regardless of path. This can be accomplished as follows:

1. Copy startup.m (found in the toolbox root directory), to the work directory of Matlab (e.g.: C:\Program files\MATLAB\R2007a\work)
2. Open startup.m (This file will be executed automatically whenever Matlab boots)
3. Edit the path so that it points to the toolbox root directory (i.e., where you unzipped the toolbox).
4. Reboot Matlab.

Test run

1. Make sure that you are in the toolbox root directory and you have run 'startup' (see above)
2. Type 'go' and press enter.
3. The toolbox will start to model the Academic2DTwice simulator. This simulator has 2 inputs and 2 outputs, and will be modeled using Rational functions, scored using CrossValidation, and samples selected using a combined GradientSampleSelector and ErrorSampleSelector method.
4. To see the exact settings used open config/default.xml. Feel free to edit this file and play around with the different options.

The examples directory contains many example simulators that you can use to test the toolbox with. See the configuration section on information about the possible options.

Problems

See the reporting problems page.

Usage and Documentation

See the Running page.

Optional: Compiling libraries

There are some alternative libraries and simulators available that have to be compiled for your specific platform. Instructions depend on your operating system.

Linux/Unix/OSX

1. Ensure you have the following environment variables set:
   1. MATLABDIR=/path/to/your/matlab/installation
   2. JAVA_HOME=/path/to/your/SDK/installation
2. Go to the toolbox root directory and type 'make'. This will build everything for you (C/C++ files, SVM libraries, ...). If you only want to build certain packages simply 'make Package' in the toolbox root. A complete list of available packages follows:

Package	Description	Requires extension pack
contrib	Builds the FANN, SVM (libsvm, LS-SVMlab) and NNSYSID libraries	Yes
cexamples	Builds the binaries for several C/C++ simulators	No

Windows

1. Compiling C/C++ codes (examples):
   1. You will have to do this on your own using a C/C++ compiler of your choice: Dev-c++/Visual Studio/...
2. Compiling SVM libraries:
   1. In order to use the LS-SVM backend, you will have to compile the LS-SVM mex files (it will work if you dont but you will get a lot of debug output).
   2. This can be done using the built-in LCC compiler of matlab, by calling 'makeLSSVM' from the Matlab command prompt. This will only work if the toolbox is already in the Matlab path. If this is not the case, refer to the Binary Installation section for more information.
3. Compiling ANN libraries:
   1. In order to use the FANN backend, you will have to compile the FANN library and mex files.
   2. So far nobody has yet got it to work under Windows, but don't let that stop you.