Versions Compared

Key

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

...

For the following sections, we will use as an example the SDJan03 detector with corresponding tag of sdjan03 for conditions lookup.

Detector Alias Files

An alias file is a property file Alias files are properties files, named alias.properties, that lists list the locations location of conditions information for a specific detector tagtags.

It has Alias files have the the following format.

No Format
[detector_name]: [conditions]

...

Recursive Name Translation

If the name value is not a URL, then it is assumed to be an alias, which . This is recursively translatedresolved recursively until the "base" value is obtained for that key.

Suppose the following is listed in the alias.properties.

...

No Format
a: b
b: c
c: d

The d name will need to be resolved using the conditions lookup algorithm.

Alias File Locations

The alias file is Alias files are stored at one or more of the following pathslocations.

  1. The LCSim work directory in the user home directory.
    No Format
    ~/.lcsim/alias.properties
  2. Within the lcsim.jar file at the following path.
    No Format
    org/lcsim/detector/alias.properties
  3. At a URL on the LCSim website.
    No Format
    http://www.lcsim.org/detectors/alias.properties

...

as this is likely the only place to which you'll have write access, and your own aliases should be kept separate from the common ones.

Conditions Lookup

Once the recursive names are resolved, conditions Conditions information for a detector tag is retrieved as follows.

  1. If the tag value is a URL with a protocol of file:, the local file (zip format) or directory path specified is assumed to contain the conditions.
  2. If the tag value is a zip file at a remote URL, an attempt is made to download the file from that location, unless the zip file is already in the local cache (~/.lcsim/cache). In this case, the local copy is used instead.

In the case of an alias to another detector tag, once the final detector name tag is determined, the algorithm searches for a directory or zip file with the same name as the tag in the following "canonical" locations:

  1. In the user home directory.
    No Format
    ~/.lcsim/detectors
    
  2. Within the lcsim.jar file.
    No Format
    /org/lcsim/detector/
  3. On the LCSim website.
    No Format
    http://www.lcsim.org/detectors/

The So the following canonical locations would be scanned for sdjan03 conditions.

...