System Requirements and Prerequisites


Most of the JPF components, including the jpf-core, are pure Java applications. The minimal version is Java SE 7 (if you have to use JDK 1.6 you have to check out the 'java-1.6' branch of our repository), we generally advise to use the latest stable Java version that is available for your platform. You can find out about your java by running

> java -version
java version "1.6.0_13"

from the command line. Please note that Eclipse versions < 3.5 might still use Java 1.5 as default on some platforms.

JPF is a resource hungry application. We recommend at least 2Gb of memory, and generally use a -Xmx1024m setting when launching Java. The disk footprint for most JPF projects is fairly small, the jpf-core takes about 40M when fully expanded with sources, compiled classes and jar files. The binary distribution (jar files) takes less than 1.5M.

Some JPF projects do require 3rd party native executables (like DLLs) that are platform specific. Please refer to the specific project pages for details.

Java specifics for Windows

Make sure you have the JDK installed, otherwise there is no javac compiler (tools.jar) available.

In order to build JPF from a Windows Command Prompt (executing ant.bat from inside the respective JPF project directory), you have to set the JAVA_HOME environment variable.

Java specifics for OS X

On Mac OS X 10.5, Java 1.5 is default, but /Applications/Utilities/Java can change the setting. In some cases, it may be necessary to manually change the symlink that determines which version is default:

sudo rm /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK
sudo ln -s 1.6 /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK

Mercurial (Version Control System)

If you want to download the JPF source repositories, you need to install the Mercurial distributed version control system on your machine, which requires Python. If you are using a Windows machine, you can install TortoiseHg, which provides a Windows Explorer extension and includes Python.

On some Mac OS X 10.5 systems, it may be necessary to set the LC_ALL and LANG environment variables for Mercurial to work correctly.

in ~/.bashrc:

export LC_ALL=en_US.UTF-8
export LANG=en_US.UTF-8 

in ~/.cshrc:

setenv LC_ALL en_US.UTF-8
setenv LANG en_US.UTF-8 

If you already have Eclipse installed, and want to download the source repositories from within the IDE, you need the MercurialEclipse plugin, which you can install from this update-site:

NetBeans comes with Mercurial support by default.

Apache Ant

Although you can also build from Eclipse, we use Apache Ant as our primary build system. Ant is no longer included in the jpf-core distribution so you have to install it separately. Currently (as of Ant 1.9.3), this involves

  • getting Ant binaries e.g. from
  • setting the ANT_HOME environment variable to the directory where you unpacked the binaries
  • adding ANT_HOME/bin to your PATH environment variable


Our Ant script (build.xml) includes a 'test' target which uses JUnit to run regression tests. JUnit is no longer included in the jpf-core distribution. For JUnit-4.11 installation involves the following steps

JPF IDE plugins

JPF components come with project configurations for both NetBeans and Eclipse, so you might want to use your favorite IDE. Since the JPF build process is Ant -based, NetBeans is generally a better fit because it is Ant based and can make direct use of your JPF site configuration.

If you want to install the Eclipse plugin, you need an Eclipse version >= 3.5 (Galileo) running under JavaSE-1.6. Please see the Installing the Eclipse plugin? page for details.

If you want to go with Eclipse and have to rebuild the JPF Eclipse plugin, make sure you install the Eclipse Plugin Development Environment (PDE) from the respective Eclipse server.

If you want to use the NetBeans plugin, the minimal NetBeans version is 6.5.

Last modified 4 years ago Last modified on 02/11/2014 08:39:00 PM