2012HackSessionNotes » History » Version 11

Luis Figueira, 2012-06-28 12:19 PM
fixed link

1 6 Luis Figueira
h1. 2012 Hack Session Notes
2 1 Luis Figueira
3 9 Luis Figueira
h2. Auxiliary Materials
4 9 Luis Figueira
5 9 Luis Figueira
h3. Hack Session Scripts
6 9 Luis Figueira
7 9 Luis Figueira
Please download the hack session script here: https://code.soundsoftware.ac.uk/projects/smallbox/files
8 9 Luis Figueira
9 9 Luis Figueira
h3. SMALLbox Cheat Sheet
10 9 Luis Figueira
11 11 Luis Figueira
Please download the SMALLBox Cheat Sheet here: https://code.soundsoftware.ac.uk/projects/smallbox/documents
12 10 Luis Figueira
13 1 Luis Figueira
14 8 Luis Figueira
h2. Running SMALLbox Add-ons 
15 1 Luis Figueira
16 8 Luis Figueira
_note: this is an example add-on developed by Daniele Barchiese._ 
17 8 Luis Figueira
18 6 Luis Figueira
These are the steps needed to interface SMALLbox add-ons to the core SMALLbox distribulation:
19 1 Luis Figueira
20 1 Luis Figueira
# Download the add-on distribution from: http://code.soundsoftware.ac.uk/projects/incoherentdl/files
21 1 Luis Figueira
** The version you wish to download is *version 1.1*
22 1 Luis Figueira
** unzip the downloaded file - this will create a folder named incoherentdl-v1_1
23 8 Luis Figueira
# Place the add-on code in any convenient location of your file system
24 8 Luis Figueira
** if you copy it to somewhere outside the SMALLBox folder, you'll need to add it to your path
25 8 Luis Figueira
*** @addpath(genpath('{incoherentdl-v1_1}'))@
26 8 Luis Figueira
** if you place it under the @{SMALLBox Root}/Toolboxes@ folder, it will be added when you run the init script
27 6 Luis Figueira
# Modify the relevant files in the folder @{SMALLBox Root}/config/@
28 6 Luis Figueira
** modify or create @{SMALLBox Root}/config/SMALL_learn_config_local.m@
29 7 Luis Figueira
*** @cp {SMALLBox Root}/config/SMALL_learn_local.m {SMALLBox Root}/config/SMALL_learn_config_local.m@
30 6 Luis Figueira
**** this local file is not tracked by Mercurial 
31 6 Luis Figueira
**** if you need to revert to the _default_ SMALLbox setting, you just need to delete/rename your local file
32 5 Luis Figueira
*** add the following code to the local config file: 
33 2 Luis Figueira
<pre>
34 2 Luis Figueira
elseif strcmpi(DL.toolbox , 'SMALL_incoherentDL')
35 3 Luis Figueira
  DL=SMALL_incoherentDL ( Problem , DL ) ;
36 3 Luis Figueira
   % we need to make sure that columns are normalised to % unit lenght .
37 3 Luis Figueira
  for i = 1: size(DL.D,2)
38 3 Luis Figueira
    DL.D(: ,i)=DL.D(: ,i)/norm(DL.D(: ,i));
39 3 Luis Figueira
  end
40 2 Luis Figueira
  D = DL.D;
41 2 Luis Figueira
</pre>
42 6 Luis Figueira
# Run the @SMALLboxInit.m@ script to set environmental variables
43 6 Luis Figueira
# Run any function or script contained in the add-on.
44 4 Luis Figueira
** example: 
45 6 Luis Figueira
*** @load test_mocod.mat@ 
46 6 Luis Figueira
**** located in @incoherentdl-v1_1/results/test_mocod.mat@ (but already in path)
47 6 Luis Figueira
*** @open SMALL_test_mocod.m@
48 6 Luis Figueira
**** located in @incoherentdl-v1_1/open SMALL_test_mocod.m@
49 1 Luis Figueira
*** run the code from the block that starts on line 110 (with the comment Plot Results)
50 1 Luis Figueira
**** this will display two coherence/signal to noise ratio plots based on results previously computed