Installation instructions

Architecture

• Linux and OS X are officially supported OS's.
• Ravelin is not officially supported on Windows, but can be made to work without too much effort.

Installing Ravelin on Debian/Ubuntu from binaries

Step 1: Add ppa gwu-positronics/ravelin to your software sources, update, and install Ravelin:

$ sudo add-apt-repository ppa:gwu-positronics/ravelin

or do this directly adding these lines to /etc/apt/sources.list:

#Ravelin on Launchpad
deb http://ppa.launchpad.net/gwu-positronics/ravelin/ubuntu trusty main
deb-src http://ppa.launchpad.net/gwu-positronics/ravelin/ubuntu trusty main

Step 2: to update apt sources, run command:

$ sudo apt-get update

Step 3: to install Ravelin

with only binaries, run command:

$ sudo apt-get install ravelin

or only install all Ravelin dependencies with:

$ sudo apt-get build-dep ravelin

and then install the github source with:

$ git clone https://github.com/PositronicsLab/Ravelin.git

Debugging tips:

if there are any missing dependencies (from older versions of ubuntu), tell apt where to find packages from trusty:

add these lines to /etc/apt/sources.list:

#trusty sources
deb http://us.archive.ubuntu.com/ubuntu trusty main universe 
deb-src http://us.archive.ubuntu.com/ubuntu trusty main universe

and then redo steps 1-3 above

Installing Ravelin on Debian/Ubuntu from source

$ sudo add-apt-repository ppa:gwu-positronics/ravelin
$ sudo apt-get update
$ sudo apt-get source --build ravelin

Installing Ravelin from github source (OS X and Linux)

The following packages are required for building from source:

• cmake
• BLAS (currently part of a standard XCode install on OS X)
• LAPACK (currently part of a standard XCode install on OS X)
• libxml2
• Boost

The necessary packages can be installed on Ubuntu Linux using:

$ sudo apt-get install cmake liblapack3-dev libatlas-dev libboost-dev libxml2-dev

The necessary packages can be installed on OS X using MacPorts, Homebrew, or even through readily available binaries.

Download the source code

You can then download the source from Github:

$ git clone https://github.com/PositronicsLab/Ravelin
$ cd Ravelin

Configure and build

Now install Ravelin from source using a standard CMake process (i.e., create a build directory, run cmake, then make, then make install):

Ravelin $ mkdir build
Ravelin $ cd build/
Ravelin/build $ cmake .. -DCMAKE_BUILD_TYPE=RelWithDebInfo 
Ravelin/build $ make
Ravelin/build $ sudo make install

Useful build options

• DISABLE_EXCEPT This option disables frame checking (and throwing subsequent frame exceptions). We recommend you set this option to OFF unless you are very confident that your software is bug-free.

Wiki home