Ikaros on Linux

Installation

The preferred way to install Ikaros is through the command line using the commands listed below.

1. Install dependencies

sudo apt-get update && sudo apt-get install cmake g++ libjpeg-turbo8-dev libgsl0-dev libpng-dev libblas-dev curl libavcodec-dev libavformat-dev libswscale-dev

2. Download the Ikaros source or clone the github repository

2a. Git: Cloning the ikaros-project on github

sudo apt-get install git
git clone http://github.com/ikaros-project/ikaros.git

2b. Download only the source in a tarball.

mkdir ikaros && curl -L https://github.com/ikaros-project/ikaros/tarball/master | tar zx --strip 1 -C ikaros

3. Build Ikaros

cd ikaros/Build
cmake ..
make

Running Ikaros

At the shell prompt write the following:

> ikaros experimentfile.ikc

Here, "experimentfile.ikc" is the path to the experiment you want to run. You must set up your search path so that it includes the directory with the Ikaros binaries. This is usually the directory IKAROS/Bin. Command line options can also be specified here.

Note that the Ikaros binary must be placed at the correct location relative to the Source directory. If you move the binary from the Ikaros/Bin directory or set up your path so that Ikaros/Bin in in your search path, you need to change IKAROSPATH in IKAROS_System.h to point to the absolute location of the Ikaros directory.

Adding a module

While quite easy to add another module to the simulator it does involve a few steps. The idea is to create a new folder to hold the module, add the folder to the project, add a bit of documentation (you will thank yourself for doing this), and tell the system to add the module to the Ikaros.

  1. Create a new folder in UserModules. The easiest way to do this is to go to UserModules and copy the 'MyModule' folder; do not forget to rename the folder as well.
  2. Add your code as appropriate.
  3. Edit the ikc-file to add documentation.
  4. Add the following line to the code to install the module substituting the name of your module and its path in the source tree:
    			static InitClass init("MyModule", &MyModule::Create, "Source/UserModules/MyModule/");
    			

An example on how to write an IKAROS module can be found here.

Optional installs

Optionally Install ARToolKitPlus

Get and extract ARToolKitPlus (https://launchpad.net/artoolkitplus)

ARToolKitPlus library is used by the Ikaros module MarkerTracker

wget https://launchpad.net/artoolkitplus/trunk/2.3.0/+download/ARToolKitPlus-2.3.0.tar.bz2
tar xfv ARToolKitPlus-2.3.0.tar.bz2

Compile ARToolKitPlus:

cd {ARToolKitPlus}
cmake .
make
sudo make install

Optionally Install OpenKinect

OpenKinect/Freenect is used by the Ikaros module Kinect

sudo apt-get install freenect

Optionally Install Code::Blocks

sudo apt-get install codeblocks

Optionally Generate a Code::Blocks project file

cmake .. -G "CodeBlocks - Unix Makefiles"