Prerequisites
To build the org.lcsim software, you should have the following installed.
- Java JDK 1.5.x (aka 5.0)
- Netbeans IDE 4.1 (optional but recommended)
- install the Netbeans with JDK 5.0 bundle if you don't already have a suitable Java SDK installed
- Maven
- Follow the instructions at Installing Maven with Netbeans Support to setup Maven.
- CVS client
Windows CVS Clients
- cvs), command-line program
- Tortoise CVS, graphical CVS client with Explorer integration
SLAC Unix Tools
The tools above , with the exception of Netbeans, are all
pre-installed on SLAC Unix.
Just issue the command:
setenv JAVAVER 1.5
to make sure you get the correct Java version.
Building org.lcsim software
The lcsim software consists of two packages, a geometry package,
and the analysis and reconstruction package. You must obtain and
build the geometry package first, since the analysis package
depends on it.
Here are condensed instructions, which you can execute from
the Linux or Cygwin bash shell.
export CVSROOT=:pserver:anonymous@cvs.freehep.org:/cvs/lcd cvs login (just hit enter when prompted for password) cvs co GeomConverter cvs co lcsim cd GeomConverter maven cd ../lcsim maven
Keeping the Release Current
Oftentimes new directories are added in a new release. In order
to make sure that cvs adds those, please use the command
cvs update -PdA
which will
P: prune empty directories
d: create directories
A: reset sticky tags
man cvs
will give more information on the cvs program.
Installing Custom JARs into JAS3
Developers of org.lcsim may want to use a version in JAS3 that is more up-to-date
than the distributed plugin.
Execute the following from the lcsim checkout directory to install the lcsim target
JAR into the JAS3 extensions directory, overwriting the JAR that was automatically
downloaded.
maven jas:install
This will copy the lcsim and GeomConverter jars to ~/.JAS3/extensions.
Testing the installation
Test Directory
By default, maven will also run the JUnit tests associated with this distribution.
Test reports are written to
target/test-reports/
If you wish to build without testing, issue the following command:
maven -Dmaven.test.skip=true
To execute a single test case, e.g. for org.lcsim.recon.cluster.fixedcone.FixedConeClusterer:
maven test:single -Dtestcase=org.lcsim.recon.cluster.fixedcone.FixedConeClustererTest
Additional Component Tests
There are also other component tests for many of the org.lcsim classes. Until they can be ported
to the JUnit structure they need to be manually executed. Do so with the following ant target:
ant -f ctest.xml
Running Classes from the Command Line
We have defined a Maven goal that allows users to run a Java class in the project from the command line
using the freehep-run-plugin.
For example:
maven run -Drun.class="org.lcsim.geometry.compact.converter.heprep.Main" -Dargs="test/org/lcsim/geometry/compact/sdjan03_compact.xml tst.heprep"
The above command run the Main class to convert the given compact description to a HepRep.
Building org.lcsim with Eclipse
Instead of NetBeans, you can also use the Eclipse IDE to build org.lcsim and write your applications.
Download Eclipse:
http://eclipse.org/downloads/index.php
The Mevenide plugin can be installed as follows:
Help->Software Updates->Find and Install...
Select "Search for new features to install", click 'Finish'
Select "New Remote Site"; for Name enter "Mevenide", for Location enter http://mevenide.codehaus.org/release/eclipse/update/site.xml
Select the latest versions of both Maven and the Mevenide plugins, click 'Next'
You will have to agree to a license agreement.
The plugin will then be downloaded.
Confirm the installation with 'Install All'
When finished, you will be asked to restart the workbench.
Click 'Yes'.
Importing org.lcsim directly from CVS
You can now install the CVS project by selecting File->New->Project
Select "CVS project" and enter the information about server and password from above.
org.lcsim will be downloaded into the workbench.
You can add the 'Maven nature' and the 'Java Nature' to your project by right clicking on the project and selecting the entry from the context menu.
Source Path
You may have to change the source path of the project, otherwise Java may be inclined to look for packages src.org.lcsim.* instead of org.lcsim.*. This can be done by right-clicking on the project and selecting Properties->Java Build Path. The src/ folder should be selected as the only source folder.
External Dependencies
When building the project outside of Eclipse, Maven secretly downloads a plethora of external libraries. If you want to build the project inside of Eclipse, you have to add those libraries to the build path. This can be done by right-clicking on the project and selecting "Properties". The JAS libraries can be used alternatively.