Difference between revisions of "Documentation of SBS-offline"

From Hall A Wiki
Jump to: navigation, search
(→‎Instructions for analyzer installation compatible with cmake)
(→‎Getting the code and building the program)
Line 22: Line 22:
 
*for your environment settings, in addition to the two lines mentionned in the instructions, you still want to define ANALYZER as the path to your install directory e.g.
 
*for your environment settings, in addition to the two lines mentionned in the instructions, you still want to define ANALYZER as the path to your install directory e.g.
 
  * setenv ANALYZER $HOME/local/analyzer
 
  * setenv ANALYZER $HOME/local/analyzer
 +
 +
===Downloading the repository===
 +
 +
The code is hosted on a github repository owned by JLab. To clone via ssh (preferred method on JLab batch farm), do:
 +
 +
{| class="wikitable" style="background: #BFBFBF;"
 +
|-
 +
| '''git clone git@github.com:JeffersonLab/SBS-offline.git'''
 +
|-
 +
|}
 +
 +
For this method to work, the ssh public key on the machine where you want to get the code must be added to your github account (see [https://help.github.com/articles/generating-ssh-keys/ Guide] to generating ssh keys and adding to your github.com account.)
 +
 +
Cloning the repository defaults to the "master" branch.
  
 
==Useful links==
 
==Useful links==

Revision as of 23:37, 27 February 2020

Documentation of SBS-offline: Overview

This page is maintained by the UConn group (Eric Fuchey + Andrew Puckett) and as of February 14, 2020 is specific to the master branch of SBS-offline on github.

Purpose

This page documents the SBS-offline program code, which purpose is to perform the data analysis for the upcoming SBS experiments.

Getting the code and building the program

Prerequisites

  • Working ROOT installation. libsbsdig is compatible with ROOT version 5 and ROOT version 6. ROOT 6 is strongly recommended
  • Working analyzer built with cmake. for that purpose, refer to the instruction below.

Instructions for analyzer cmake installation compatible

clone the analyzer repository from: 

* git clone git@github.com:JeffersonLab/analyzer.git

build it with cmake following the instructions at: 

* https://github.com/JeffersonLab/analyzer#compiling-with-cmake

2 precisions:

  • it seems that in these instructions the "build" directory has to be in the analyzer directory.
  • for your environment settings, in addition to the two lines mentionned in the instructions, you still want to define ANALYZER as the path to your install directory e.g.
* setenv ANALYZER $HOME/local/analyzer

Downloading the repository

The code is hosted on a github repository owned by JLab. To clone via ssh (preferred method on JLab batch farm), do:

git clone git@github.com:JeffersonLab/SBS-offline.git

For this method to work, the ssh public key on the machine where you want to get the code must be added to your github account (see Guide to generating ssh keys and adding to your github.com account.)

Cloning the repository defaults to the "master" branch.

Useful links

Retrieved from "https://hallaweb.jlab.org/wiki/index.php?title=Documentation_of_SBS-offline&oldid=38448"