You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Overview

The HPS Java Project is based on the org.lcsim framework and provides a full set of physics reconstruction and simulation tools compatible with the LCIO data format.

Preliminary Tools

Before beginning the installation process, you will want to have available the following tools on your machine first.

Unix

The project itself is cross-platform and should run on Linux, OSX and Windows.  These setup instructions assume a Unix-like environment using the bash shell.  Windows users should be able to execute the equivalent commands on their system to perform the installation successfully.

Java

Java on your system

If you are using a shared Unix environment or a machine that is centrally managed, you will want to check first with your system administrator about installing Java.  They may want to do this themselves, or the JDK may already be installed and available for you to use without needing to install it yourself.

The software is currently compatible with Java versions 1.7 and greater.  It will not currently build with Java 1.6 or other earlier versions.  You need to download the "Java Platform (JDK)" and not just the JRE.

The bundle for your system should be downloaded from the Java SE downloads site.  Then you need to follow the setup instructions listed there.

You may want to add lines like the following to your shell initialization script, especially if Java is not installed in a standard system location like the /usr directory.

export JAVA_HOME=/path/to/java/jdk
export PATH=$JAVA_HOME/bin:$PATH

This will make sure that the shell can find the Java commands such as java and javac that will be needed for the installation.

Once the Java installation is completed, you should make sure that the compiler is available from the command line.

[$] javac -version
javac 1.7.0_17

If this command prints "command not found", the current PATH variable probably does not contain the Java bin directory or the location was set incorrectly.

Maven

Maven is a Java based build tool used to create a runnable version of HPS Java on your machine.

You will need to get Maven from the Maven Download Site and save (for instance) the tar.gz file to your machine.

Then you can set it up as follows.

tar -zxvf apache-maven-3.2.3-bin.tar.gz
export MAVEN_HOME=$PWD/apache-maven-3.2.3
export PATH=$MAVEN_HOME/bin:$PATH

Now you should check that the mvn command works.

[$] mvn -version
Apache Maven 3.2.3 [etc.]

If this command does not work, then you should check that the PATH variable is set correctly.

Subversion

Subversion on your system

Subversion is a common tool on Unix systems, and it is likely already installed for you to use.  If not, then check with your system administrator about installing it.

Subversion is the source control system system used to obtain the source code from a remote server.  You will need the Subversion client tool in order to checkout the HPS Java code.

Subversion should not be compiled from source code.  It is probably best to either have your local administrator install it if it is not present already, or you can use your package manager (like yum on Redhat systems).

This is an example of using your package manage to do this.

yum install subversion

Windows users can install the TortoiseSVN tool, but its usage is not covered in these instructions.

 

 

  • No labels