RapidMiner Installation Guide

From Rapid-I-Wiki

Revision as of 10:22, 18 October 2010 by Admin (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The installation of RapidMiner is very simple. This installation guide describes the installation process for Microsoft Windows systems as well as for all other supported platforms. You can also find some comments how RapidMiner can be started and how the installation can be further improved.

Contents

Installing RapidMiner (Windows)

On a Microsoft Windows system, you only have to download the executable installer file rapidminer-XXX-install.exe (where XXX stands for the current version of RapidMiner). After the download has finished, you should double-click on the downloaded file and follow the instructions of the setup dialog. After installation has finished you will find a new start menu entry and desktop icon for RapidMiner. That's all. Please note that there is no need for an extra Java installation.

Installing RapidMiner (any platform) Step 1: Installing Java

In order to use RapidMiner you need a Java Runtime Environment (JRE) version 1.5 (officially Java 5.0) or higher, which you can download from SUN. Just download the correct version for your operating system (Windows, Mac, Linux, etc.) and install it on your system.

Installing RapidMiner (any platform) Step 2: Download and extract RapidMiner

You have to download the Java binary Zip archive (rapidminer-XXX-community.zip) containing all necessary files for RapidMiner. In order to extract the downloaded RapidMiner archive you can use any file decompression tool available to you. RapidMiner is now installed.

Installing Plugins

If you want to use one of the RapidMiner plugins, just download the plugin Jar file and copy it into the subdirectory lib/plugins in your RapidMiner program directory. Windows users can also simply use the provided installer (.exe) files.

Starting RapidMiner: Windows

Perform a click on the start menu entry or a double click on the desktop icon in order to start RapidMiner. Please note that RapidMiner automatically uses 80% of the free memory during startup. This should be ok for most applications. If you run into memory problems, you should check out one of the other possibilities to start RapidMiner.

Starting RapidMiner: Any Platform - Way 1

Two ways exist to start RapidMiner on any supported platform. The main reason why one should start RapidMiner with one of these ways is to adapt the amount of memory which is allowed for usage. The default Java installation uses only a small amount of memory (64 or 128 Mb) even if your system provides more physical memory (this is different for the Windows installation, see above). Therefore we recommend to define the maximum amount of memory which can be used by Java and the location of Java itself via the environment variables MAX_JAVA_MEMORY (e.g. 800) and JAVA_HOME (installation path of Java). Afterwards you can double click on the start script RapidMinerGUI.bat in the scripts subdirectory of RapidMiner or invoke it from command line (please note that we also provide start scripts for Linux / Unix but it might be necessary to change the file settings with "chmod 750 RapidMinerGUI" or something similar). This will start the graphical user interface of RapidMiner. Please note that increasing the maximum amount of memory via environment variables only works, if RapidMiner is started by using one of the start scripts. It does not affect the memory, if a start menu item or desktop icon were used on a Windows system.

Starting RapidMiner: Any Platform - Way 2

On some platforms it simply works to perform a double-click on the file lib/rapidminer.jar in order to start RapidMiner.

Starting RapidMiner: Any Platform - Way 3

Users familiar with Java might also want to start RapidMiner via the command line (java -jar rapidminer.jar). The maximum amount of memory can be specified via the -Xmx option of the Java Virtual Machine, e.g. java -Xmx800m -jar rapidminer.jar. Please note that there is no empty space between the -Xmx option, the amount of memory (800 in this case), and the unit (m for Mb in this case).

Defining RAPIDMINER_HOME

Important: if any problem occurs during starting RapidMiner via Java invocation, the reason for this is almost always that RapidMiner cannot find its resource files (icons etc.). In this case you have to declare the location of RapidMiner to Java by typing

java -Drapidminer.home=C:\path\to\your\rapidminer\installation -jar rapidminer.jar

telling Java to start from the location "rapidminer.home".

Please note that you have to enclose your path to the RapidMiner home directory with double quotes ("), if the path includes empty spaces. If you want to start RapidMiner from another directory, you will have to adapt the lib-path (lib\rapidminer.jar), while the path to rapidminer.home remains the same.

As far as we know, this problem only occurs for version 3.3 of YALE (and not for RapidMiner). For other versions of RapidMiner and YALE, it should work just using the start script, a double click on lib\rapidminer.jar (lib\yale.jar), or typing java -jar lib\rapidminer.jar (java -jar lib\yale.jar).

External links

Personal tools