Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Cloning the repository

Committers

Code Block
languagepowershell
titleCloning the REEF repository for committers
git clone https://git-wip-us.apache.org/repos/asf/reef.git

Users

Code Block
languagepowershell
titleCloning the REEF repository for everyone else
git clone git://git.apache.org/reef.git

Setting the Runtime Java Environment

The version of Java used to compile REEF is controlled in the Maven pom.xml file in the build plugins section under the maven-compiler-plugin artifact identifier. In order to run REEF applications, you must set the JAVA_HOME environment variable to the correct Java installation directory for your operating system and java version.

Linux

On a number of Linux distributions such as Ubuntu, the current active version of Java is controlled via links from /usr/bin set by the update-alternatives command; thus, the value of JAVA_HOME that causes REEF to use the Java version controlled by update-alternatives is given in the code block below. REEF will concatenate the appropriate path to find executable files. 

...

Code Block
languagebash
titlebash script to list all installed Java versions on Linux
update-alternatives --config java

Windows

On Windows, the JAVA_HOME environment variable is set by the Java installer to $SYSTEM_DRIVE\Program Files\Java\jdk[version number]. You can examine the value of JAVA_HOME on Windows by entering the following command in a powerShell console window.

Code Block
languagepowershell
titlePowerShell command to view JAVA_HOME
$env:JAVA_HOME

Test Environment Configuration

The REEF unit tests require a large number of simultaneously open files to successfully complete. This may or may not be allowed by your platform administrator.

Ubuntu

The default number of open files in an Ubuntu shell is 1024. You can verify this by typing the following command at the shell prompt.

...

Now type "ulimit -n" at the shell prompt and you should get return a value of 40960 which should be sufficient to run the REEF unit tests.

Compiling

Java build instructions

C# build instructions

...