= ALOE Quick Start Guide =

This page describes how to download, install and run an example waveform for ALOE for Linux OS. 

Supported processors are:
 * x86_32
 * x86_64
 * ARM (tested in MARVELL processors from [http://www.plugcomputer.org/ SheevaPlug])
 * PPC440 comming soon... 

== Downloading & Installing ==

Download source from http://flexnets.upc.edu/svn/phal/tags/aloe-1.4.2.tar.gz

Alternatively, but not recommended, you can also download the latest developing trunk version:
{{{
svn co http://flexnets.upc.edu/svn/trunk
}}}

Before installing, make sure you have the following libraries in your system:

 * readline (4.0 should be fine)
  * ftp://ftp.gnu.org/gnu/readline/
 * termcap
  * ftp://ftp.gnu.org/gnu/termcap/      
 * jack 
  * http://jackaudio.org/download

For debian users, just type:
{{{
sudo apt-get install libreadline5-dev
sudo apt-get install libjack-dev qjackctl libjack0 jack jackd jack-tools
}}}

Untar, compile and install: 

{{{
tar xzvf aloe-1.4.2.tar.gz
cd aloe-1.4.2
./configure
make
sudo make install
}}}

Before running ALOE, we must tune some kernel parameters to enable large messages buffers. You can use sysctl to make changes permanently, add the following lines to /etc/sysctl.conf
{{{
kernel.msgmnb=1048576
kernel.msgmax=10485760
kernel.msgmni=128

}}}

And run sysctl with root permissions:
{{{
sudo /sbin/sysctl -p
}}}


== Running an example ==

From the same directory where the source is (aloe-1.4.2):
{{{
runph
}}}

To run ALOE in real-time you must launch it with root permissions:
{{{
sudo runph
}}}

Note that since ALOE executables are installed in /usr/local/bin, make sure this path is accessible from sudo (visudo command).

And in the runph prompt:
{{{
runph$: phload modem
runph$: phinit modem
runph$: phrun modem
}}}

And your waveform is running!

You can now view information about execution time:
{{{
runph$: execinfo modem
}}}

You can list available statistics and view/modify them:
{{{
runph$: statlist modem
runph$: statget modem turbodecoder max_iterations
runph$: statset example turbodecoder max_iterations 12
}}}


=== aloeUI ===

To run the aloeUI start runph as a daemon and then run aloeui.run command from the aloe-1.4 directory
{{{
sudo runph --daemon
runph -gui
}}}

Remember to kill background ALOE processes when you finish. After closing the GUI, type:
{{{
sudo killph
}}}

[[BR]]
[[BR]]
[wiki:ALOE "[Back to ALOE]"]