Versions Compared

Key

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

Table of Contents

Distribution Jar

It is assumed in the instructions below that hps-distribution-bin.jar refers to a local copy of the HPS Java distribution from the target dir with an actual version.  

...

Some XML steering files have variables that need to be resolved with command line arguments.

Steering Files

Steering File Location

The standard location for steering files is steering-files/src/main/resources/org/hps/steering/ in HPS Java.

This folder is organized into the following sub-directories which contain sets of related steering files.

DirectoryDescription
 analysis analysis steering files (includes analysis template)
broken  broken steering files that may be removed soon
calibration  calibration steering files (not really used currently)
monitoring  steering designed to be run in the monitoring application
production  production steering including event skimming configurations and Data Quality
recon  reconstruction steering files including Eng Run 2015
users user steering files (organized into sub-directories by user name)
  

These steering files can be accessed using their path on disk, or they can be referenced as classpath resources.  The exact syntax depends on the command line tool.

For example, a steering file resource might be accessed like this using the job manager.

Code Block
languagebash
java -jar ./hps-java-trunk/distribution/target/hps-distribution-bin.jar -x /org/hps/steering/recon/EngineeringRun2015FullRecon.lcsim [...]

The same steering file could also be accessed as a file from the local copy of HPS Java.

Code Block
languagebash
java -jar ./hps-java-trunk/distribution/target/hps-distribution-bin.jar hps-java-trunk/steering-files/src/main/resources/org/hps/steering/recon/EngineeringRun2015FullRecon.lcsim [...]

You can use a file rather than a resource if you running a steering file which is not checked into HPS Java or you are using a modified steering file that has not been packaged into the distribution jar.

Steering File Variables

For instance, suppose the XML file has this variable definition.

...

This will not actually work (just provided to show all command line options at once).

EvioToLcio

Run Scripts

Using your own steering file

All instructions given here assume you're using the steering files included with the release. If you write your own, you can point hps-java to it by omitting the "-r" and using the file path of your .lcsim file:

No Format
java -jar hps-distribution.jar -i recon.slcio my_steering_files/MyAnalysis.lcsim -DoutputFile=analysis_plots

If a detector name and run number are both supplied as arguments from the command line, the conditions system will be initialized and frozen, meaning that subsequent event numbers from data will be ignored.

EvioToLcio

Run Scripts

 The standard steering files are in trunk/steering-files/src/main/resources/org/hps/steering/.

Logging and Debugging

Logging Config

...