This is a short tutorial that shows how to install Odysseus and how to setup the first time. This tutorial is for persons who just want to use Odysseus for data stream management. For those, who want to develop with Odysseus (e.g. create new operators or extend functionalities), may have a look at Development with Odysseus, which introduces how to import Odysseus into Eclipse.
New: 1.10.15: Java 8 is now the required base!
First, Java 8 (also known as Java 1.8) must be installed, which you can download here: http://www.java.com.
Since the installed Java version must not match with the one that Odysseus wants to use, Mac OS users may have a look here: Mac OS X and Java 7
2. Download Odysseus
Go to Odysseus Website to the Download section. You can choose between a stable version, which is stable but may not be the latest version, or you choose a nightly build which consits the latest fixes and is built each day at midnight. Choose the Version for your operating system in a 64 or 32 bit version. In our case, we have a 64 bit Windows 7 so that we choose Windowx x86 64 bit. Download the archive.
Next, you have to unzip the archive. There is no installer nor a dedicated installation directory. Thus, you can choose a destination of your choice (In some cases, Odysseus does not behave correctly, if the installation path is to long. In this case try to install Odysseus to another location).
- If you want to use the update feature, do not install Odysseus in a shared folder.
- Under windows: Do not use folder "program files".
- Important: Do not use an existing directory, e.g. from an older Odysseus installation! If you want to update, see How to update Odysseus.
After unpacking, you may have something like the following:
4. Start Odysseus
Run "studio.exe" to start Odysseus.
- As studio is an Eclipse based application you can raise the memory the same way:
- If an error occurs at start, try to execute
java -versionon a console to see if the right Java version is installed and reachable.
change Xms and Xmx to the needed values. Default is 1000M.
5. Choose Workspace
At the first start, you have to choose a workspace. This workspace is a directory where all Odysseus projects will be stored.You can also check the "Use this as the default.." option so that this dialog will not pop up at the next start of Odysseus.
Next, Odysseus asks you for a user and a password. The default user is "System" with password "manager". You can also check "Login automatically" so that username and password is saved and used automatically at the next start so you don't have to type in your login data again. In some cases there may be a field "Tenant". For most cases this field should be empty.
If you are using the client version of studio, the WebService tab must contain information about the Odysseus Server:
After that, Odysseus Studio starts, so you should the the interface:
7. Next steps
You now can use Odysseus. Now, you can, for example, make yourself familiar with Odysseus Studio or you may create or import projects. For further steps, you may have a look at these pages:
- Odysseus Studio introduces the interface, views and commands
- Run Nexmark Example shows a tutorial how to run an example that is based on the Nexmark benchmark, including a data generator.
- Hands on Data Stream Processing shows different tutorials how Odysseus can be used in different projects - including special hardware
A. Hints if installation/start fails
- Java 1.7 (or sometimes called Java 7) has to be used. Although Java 1.7 was installed, it may happen that Java 1.6 is still used. Therefore, check if 1.7 is used. Check also, if JAVA_HOME is set correctly.
- On windows, you can check the version by open the command line to tool (go on "start", and "run" and enter "cmd", then press OK. In the command line enter "java -version" and hit enter. You should see some lines beginning with "java version "1.7.XXXX". if command is not found or another version is shown, check your Java installation.
On MacOS X, you may look at "B. Mac OS X and Java 1.7" in the next section.
- Be sure you downloaded the x86_64 version if you have a 64 bit operating system or the x86 version if you have a 32 bit operating system.
B. Mac OS X and Java 8
To run Odysseus from the pre-compiled packages available to download you have to do the following steps.
- Download and install Java 8 from Oracle (/usr/libexec/java_home -t BundledApp shut output a Java 8 version)
- Download Odysseus from our homepage
- Open the terminal (e.g. with spotlight)
- Direct to the odysseus-folder (go into it)
- Run the following command:
C. Installation under Linux
Odysseus should be installed for a single user. The user that starts the server process must have all rights to the installtion directory, else no new features can be installed and no features can be updated.
To run Odysseus you need a Java runtime environment in version 7.
Download and unzip the Odysseus package to your local bin folder
Add the Odysseus folder to your PATH variable
D. Running Odysseus Server on Raspberry Pi, Beagleboard Black Rev C
The Odysseus server component works on a Raspberry Pi. Simple install a recent raspian first.
You should use a distinct user for odysseus.
After that, you should update/upgrade the system and install JavaJRE:
Tip: With the console-command
raspi-config you can configure your RaspberryPi/BananiPi further (e.g. keyboard layout)
The following script will download and install Odysseus as a server-component
Alternatively, if multiple Odysseus-Instances should be connected (Peer-to-Peer-Network of RaspberryPi), you should download the Peer-Version of Odysseus:
The following script will execute Odysseus (Server-Version) with respect to restarts due to possible future updates (downloadable: http://odysseus.informatik.uni-oldenburg.de/download/products/server/startOdysseusServer )
Attention: If you downloaded and installed the Peer-Version of Odysseus, you have to replace "server" with "peer" in the 3rd line (or download it from http://odysseus.informatik.uni-oldenburg.de/download/products/peer/startOdysseus).
Attention: The script-file must be made executable with
chmod +x startOdysseus
For the standard Beagle board "unzip" and "java" must be installed:
Start same as above the raspberry.
Further devices tested:
- Cubiboard use e.g. http://www.igorpecovnik.com/2013/12/24/cubietruck-debian-wheezy-sd-card-image/
- Cubiboard 3 (Cubietrack), Image use e.g. http://www.igorpecovnik.com/2013/12/24/cubietruck-debian-wheezy-sd-card-image/
- Banana Pi
For a "quick and dirty" way to start Odysseus automatically on startup, you have to edit the file
/etc/inittab according to these instructions: http://elinux.org/RPi_Debian_Auto_Login
At the following to the end of the file
.bashrc of the user (e.g.,
Remark: For BeagleBone, autologin has to be activated like here described
Create a file odysseus in folder /etc/init.d/, give execute rights and replace DAEMON_PATH with your installation directoy, replace DAEMON with startOdysseusServer (startOdysseus in Peer)