Building RKWard From Source

From RKWard
Revision as of 05:01, 14 October 2010 by Kapatp (Talk | contribs)

Jump to: navigation, search

Contents

Purpose

The purpose of this page is to give you step-by-step instructions to compile and install RKWard from sources.

Related pages

Picking the right version of RKWard

Currently, RKWard is published in two different versions, one for KDE 3 based systems (RKWard versions numbered up to 0.4.9x), one for KDE 4 based systems (RKWard versions numbered 0.5.0 and above).

KDE 4 based system, here, means that you have only version 4 of the KDE libraries. You do not necessarily have to run a full KDE 4 desktop. In fact, on systems with both versions of kdelibs, either version of RKWard can be used.

Note that active development is focused on the KDE 4 series of RKWard. For the KDE 3 series, we only publish the most important bug fixes from time to time. Therefore, if you want the latest and greatest RKWard, use the most recent version above 0.5.0.

Building RKWard 0.5.0 and above

Requirements

RKWard requires:

  • KDE-libraries and headers (>= 4.0) (http://www.kde.org)
    • The names of the required packages differ from distribution to distribution. Some are called "kdelibs4", some "libkde4", on Debian and Ubuntu the name is "kdelibs5". For the headers you will generally need packages called "kdelibs4-dev", "libkde4-devel" or similar.
  • Qt-libraries and headers (>= 4.3) (http://www.trolltech.com)
    • On most systems these should be installed automatically, when you install the KDE-libraries, above.
  • X11-libraries and headers (http://www.x.org)
    • On many systems these will be installed automatically, when you install the KDE-libaries. On other systems you may need to install libx11-dev/x11lib-dev, manually.
  • R and headers (http://www.r-project.org)
    • Common package names are "r", "r-base", etc. Note that some distributions package the HTML-documentation in a separate package, so look out for "r-base-html" or similar package names.
  • CMake (http://cmake.org)
    • Generally this package is called "cmake".

If you can't find the required packages for your distribution, take a look at Binaries_and_Build_Scripts for distribution specific information, or contact us for help.

Debian derivatives:

  • On Debian based systems (such as Ubuntu) the following will get all the dependencies installed (and hopefully the package names will be similar on other distributions):
$ apt-get install kdelibs5 kdelibs5-dev libx11-dev r-base-core r-base-dev cmake

Compilation

IMPORTANT: You will need to have the R shared library installed. This is typically located in a place like /usr/lib/R/lib/libR.so. Unfortunately, some distributions do not yet ship their R binary with the shared library. In those (rare) cases, you'll have to compile and install R on your own with the option --enable-R-shlib.

Suppose the source is obtained as (here rkward-0.5.3.tar.gz is used as an example, change it accordingly):

$ tar xzf rkward-0.5.3.tar.gz # extracts to rkward-0.5.3 directory
$ cd rkward-0.5.3

Then, the recommended way to build from source is:

$ mkdir build; cd build
$ cmake .. [options]	# see Path to sources and CMake options below
$ make
$ sudo make install

Path to sources

The cmake command needs to know the path to rkward sources. Typically this where the CMakeLists.txt file exists. Since, in the example above, the build directory was created inside the extracted source directory, CMakeLists.txt exists in the directory immediately above; hence '..' is the appropriate path.

CMake options (configuring)

The cmake command offers a number of parameters to control the build process. Some commonly needed are:

  • -DCMAKE_INSTALL_PREFIX
    • set the installation base directory. Generally -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix` should be correct.
    • When installing as a normal user (i.e., w/o root access), `kde4-config --localprefix` should work.
  • -DCMAKE_BUILD_TYPE
    • type of build. Useful settings include -DCMAKE_BUILD_TYPE=Release and -DCMAKE_BUILD_TYPE=debugfull

In some cases you may want to set the following options:

  • -DR_EXECUTABLE
    • path to the R executable. You may want to set this, if you have multiple versions of R installed, or R is not in your path. Example: -DR_EXECUTABLE=/usr/bin/R
  • -DR_LIBDIR
    • directory where R packages should be installed. This option is mainly of interest to packagers.
    • When installing as a normal user (i.e., w/o root access), this needs to be explicitely specified. Generally this is the R_LIBS_USER variable from the Renviron file which can be identified from withing R using:
$ R --silent
 > Sys.getenv ("R_LIBS_USER"). 
                        R_LIBS_USER
"~/R/i486-pc-linux-gnu-library/2.9"
For example, on a i386 Debian with R 2.9, ~/R/i486-pc-linux-gnu-library/2.9 is the default. Create the directory manually, if it doesn't exist: mkdir -p ~/R/i486-pc-linux-gnu-library/2.9 . Then, using -DR_LIBDIR=$HOME/R/i486-pc-linux-gnu-library/2.9 should work.
  • -DR_HOME
    • R home directory. Almost certainly this option is not needed.
  • -DR_INCLUDE
    • path to R include files. Almost certainly this option is not needed.

Further generic options are listed on http://www.cmake.org/Wiki/CMake_Useful_Variables .

Installation

As a last step, you _have to_ run 'make install'. Otherwise RKWard will be missing important menu-options, may behave strangely, or may not run at all. As root run:

$ make install

Make sure you have set the correct path in cmake (the -DCMAKE_INSTALL_PREFIX option).

Running

For now it's recommended to run RKWard from the command-line for debug-output. For the few available command-line options see

$ rkward --help

Building RKWard 0.4.9x and below

Requirements

To compile RKWard versions up to 0.4.x you need:

  • KDE-libraries and headers (>= 3.x) ([1])
  • Qt-libraries and headers (>= 3.x) ([2])
  • R and headers (>= 2.1.0) ([3])
  • PHP with commandline-interface ([4])

On Debian based systems (such as Ubuntu) the following will get all the dependencies installed (and hopefully the package names will be similar on other distributions):

# php4-cli can be used instead of php5-cli
$ apt-get install kdelibs4 kdelibs4-dev r-base-core r-base-dev php5-cli

Compilation

Suppose the source is obtained as

$ tar xzf rkward-0.4.9b.tar.gz # extracts to rkward-0.4.9b directory
$ cd rkward-0.4.9b

Then, compilation / installation is basically just a

$ ./configure [options] # see configure options below
$ make
$ make install

configure options

In most cases you will not need to pass any options to ./configure. If you run into troubles during compilation, you may need to specify these options:

  • --prefix
    • Set the installation base directory. Generally --prefix=`kde-config --prefix` should be correct. For Debian (and derivatives) this is /usr.
    • When installing as a normal user (i.e., w/o root access), `kde-config --localprefix` should work. For example, $HOME/.kde.
  • --with-qt-dir
    • In rare cases, you might also have to specify your qt (3) directory, passing the commandline-option --with-qt-dir=/usr/lib/qt3 (or similar) to configure.
  • --with-r-libdir
    • Directory where the R package of rkward is to be installed. This option is mainly of interested to package builders.
    • Although, when installing as a normal user (i.e., w/o root access), this needs to be explicitely specified. It can be identified from within R using Sys.getenv ("R_LIBS_USER"). Similar to the -DR_LIBDIR cmake option (see CMake options above).
  • --with-r-home
    • On systems with more than one version of R installed, you may need to specify --with-r-home=/correct/path to make sure the correct version of R is used.

Installation

As a last step, you _have to_ run 'make install'. Otherwise RKWard will be missing important menu-options, may behave strangely, or may not run at all. As root run:

$ make install

Make sure you have set the correct path in configure (the --prefix option).

Running

For now it's recommended to run RKWard from the command-line for debug-output. For the few available command-line options see

$ rkward --help

Troubleshooting

The most common source of problems are

  1. Missing some of the build requirements
  2. Wrong / missing parameters to cmake or ./configure

So please re-read the corresponding sections, first. If you're still in trouble, let us know, we'll be happy to help you.

For some systems, Binaries_and_Build_Scripts has more information.

Personal tools
Namespaces

Variants
Actions
RKWard
Documentation
wiki
Toolbox
Affiliations