Project

General

Profile

Wiki » History » Version 1

Eric Fuchey, 04/06/2020 11:38 AM

1 1 Eric Fuchey
==Documentation of libsbsdig: Overview==
2
3
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 libsbsdig on github.
4
5
===Purpose===
6
This page documents the libsbsdig code, which purpose is to transform the output data from [https://hallaweb.jlab.org/wiki/index.php/Documentation_of_g4sbs G4SBS] to digital values such as ADCs or TDCs.
7
These produce files which can be analyzed with [https://hallaweb.jlab.org/wiki/index.php/Documentation_of_SBS-offline SBS-offline].
8
9
==Getting the code and building the program==
10
11
===Prerequisites=== 
12
13
*Working [https://root.cern.ch/drupal/ ROOT] installation. '''libsbsdig is compatible with ROOT version 5 and ROOT version 6'''. '''''ROOT 6 is strongly recommended'''''
14
*Working [https://redmine.jlab.org/projects/podd/wiki analyzer] installation. '''libsbsdig is compatible with analyzer versions 1.6 and beyond'''.
15
*Working [https://hallaweb.jlab.org/wiki/index.php/Documentation_of_SBS-offline SBS-offline] installation.
16
17
===Downloading the repository===
18
19
The code is hosted on a github repository owned by JLab. To clone via ssh (preferred method on JLab batch farm), do: 
20
21
{| class="wikitable" style="background: #BFBFBF;"
22
|-
23
| '''git clone git@github.com:JeffersonLab/libsbsdig.git'''
24
|-
25
|}
26
27
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.)
28
29
Cloning the repository defaults to the "master" branch.
30
31
===Building and installing the library===
32
33
in the library directory, type '''make'''.
34
35
A 'cmake' build is under development, but not ready yet.
36
37
==Useful links==
38
39
*[http://git-scm.com/documentation Git Documentation]
40
*[https://github.com/JeffersonLab/libsbsdig Github.com] homepage for libsbsdig
41
*[https://github.com/JeffersonLab/analyzer Github.com] and [https://redmine.jlab.org/projects/podd/wiki wiki] homepages for the analyzer
42
*[[Documentation of SBS-offline]]