# THE AUDITORY MODELING TOOLBOX

Applies to version: 0.10.0

Go to function

# amt_start - Start the Auditory Modeling Toolbox

## Usage

amt_start;
amt_start(flags);


amt_start starts the AMT. This command must be run before using any of the function in the AMT.

## Requirements to run the AMT

1. Linear Time Frequency Analysis Toolbox (LTFAT): Download LTFAT from <http://ltfat.sourceforge.net/> and unpack to the prepared directory thirdparty/ltfat. Alternatively, save the LTFAT anywhere and add the root LTFAT (just the root!) path to the search path.
2. The SOFA API (version >= 1.0): Download the SOFA API from <http://sourceforge.net/projects/sofacoustics> and unpack to the prepared directory thirdparty/SOFA. Alternatively, save the SOFA API anywhere and add the root path of the SOFA API (just the root!) to the search path.
3. The SFS Toolbox (version >= 2.4.0). Download from <https://github.com/sfstoolbox/sfs-matlab/releases> and unpack to the prepared directory thirdparty/sfs. Alternatively, save the SFS Toolbox anywhere and add the path to the search path.
4. Python (version >= 2.6 but < 3) with the packages numpy and scipi. On Linux, type sudo apt-get install python-scipy python-numpy. On Windows, intall python from <https://www.python.org/>, add python.exe to the Windows search path, and install the packages separately.
5. amt_mex executed without any errors. See amt_mex for compiler requirements.

Note that some models may further require other toolboxes. See the corresponding documentation for more details.

## Cache:

AMT uses cache to store precalculated results because some of the AMT functions require large processing time. Depending on the machine and the model, it might take even days. The global cache mode is controlled on start-up of the AMT. To change the global cache mode choose a flags:

 'normal' Use cached package as far as possible. This is default. This is kind of demonstration mode and very convenient for fast access of results like plotting figures. This option, however, may by-pass the actual processing and thus does not always test the actual functionality of a model. If the cached package locally not available, downloaded from the internet. If remotely not available, enforce recalculation. 'cached' Enforce to use cached package. If the cached package is locally not available, it will be downloaded from the internet. If it is remotely not available, an error will be thrown. 'redo' Enforce the recalculation of the package. This option actually tests the calculations. 'localonly' Package will be recalculated when locally not available. Do not connect to the internet.

Many AMT functions support the cache mode as input flag in order to overwrite the global cache mode. See amt_cache for more details.

## Auxiliary data

Most of the models require auxiliary data. The AMT will download these data on-demand. The download URL for the auxiliary data is given by amt_auxdataurl. The target directory for the auxiliary data is given by amt_auxdatapath. If you want to run the AMT offline, download the auxiliary data first.

Some of the auxiliary data are HRTFs. The AMT will download the HRTFs on-demand. The download URL for the HRTFs is given by SOFAdbURL. The target directory for the HRTFs is given by SOFAdbPath. If you want to run the AMT offline, download the HRTFs first.

## Output

The output of the messages to the command line can be controlled by one of the following flags:

 'verbose' All output will be displayed. This is default. 'documentation' starts the AMT in the documentation compiling mode. The output of calculation progress will be suppressed. 'silent' All output will be suppressed.

Go to http://amtoolbox.sourceforge.net/doc.php for the full documentation.