E-mail
Before You Start
Overview
The org.lcsim toolkit, or "LCSim", is a Java-based toolkit for analysis and reconstruction of ILC physics events.
Platform
The LCSim toolkit is written in Java, so it should be 100% cross-platform compatible. This means that you can use Linux, Windows, or OSX as your development environment.
This tutorial will be kept as platform-independent as possible. However, some sections will include notes for different platforms if there are special procedures, different tools available, etc.
Assumptions
It is assumed that you know how to...
- Install software onto your machine given sufficient instructions.
- Set environment variables.
- Open a command terminal and execute commands on the commandline.
If this is not the case, please review these procedures for your platform.
Required Software
CVS
A CVS client is required in order to contribute to the project. It is used to checkout the source code and keep it up to date.
Mac and Linux users will have a cvs client available from the command.
Type the following into a terminal to test that the cvs command-line client is installed on your local machine.
cvs -v
It should display information about the version of CVS that is installed.
Windows users can also use a command-line CVS client, which is available as part of the Cygwin platform.
Another option for Windows users is the Tortoise CVS GUI.
Java
The LCSim project requires a Java version of 1.5 or greater.
Your machine may already have Java installed.
In a terminal or DOS cmd window, try typing the following.
java -version [ENTER] javac -version [ENTER]
If Java is setup correctly on your machine, these commands should print the version information.
A complete walkthrough of Java installation is beyond the scope of this tutorial.
Start at the Java download page and get the appropriate bundle for your platform.
 | It is recommended to only install the SE/JDK and to not install the version bundled with Netbeans, which will be done in a subsequent step. |
Maven
LCSim uses Maven as its build tool.
If you are using Netbeans, then the standalone version of Maven is an optional install as Netbeans comes with a Maven plugin.
Download Maven for your platform.
 | LCSim currently requires the 1.0.2 version of Maven so make sure you get the right installer. |
The installation of Maven creates a base directory which is referred to by the environment variable MAVEN_HOME. In order to run maven from the command line, the directory MAVEN_HOME/bin should be added to the PATH variable.
On Linux, the following can be added to a setup script to do this.
export MAVEN_HOME=/your/path/to/maven/dir export PATH=$MAVEN_HOME/bin:$PATH
On Windows, these environment variables can be set via the Control Panel under System -> Advanced -> Environment Variables.