Difference between revisions of "Documentation of libsbsdig"

From Hall A Wiki
Jump to: navigation, search
 
(9 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
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.
 
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.
 +
 +
===Purpose===
 +
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.
 +
These produce files which can be analyzed with [https://hallaweb.jlab.org/wiki/index.php/Documentation_of_SBS-offline SBS-offline].
  
 
==Getting the code and building the program==
 
==Getting the code and building the program==
Line 8: Line 12:
  
 
*Working [https://root.cern.ch/drupal/ ROOT] installation. '''libsbsdig is compatible with ROOT version 5 and ROOT version 6'''. '''''ROOT 6 is strongly recommended'''''
 
*Working [https://root.cern.ch/drupal/ ROOT] installation. '''libsbsdig is compatible with ROOT version 5 and ROOT version 6'''. '''''ROOT 6 is strongly recommended'''''
*Working [https://redmine.jlab.org/projects/podd/wiki analyzer] installation.
+
*Working [https://redmine.jlab.org/projects/podd/wiki analyzer] installation. '''libsbsdig is compatible with analyzer versions 1.6 and beyond'''.
 +
*Working [https://hallaweb.jlab.org/wiki/index.php/Documentation_of_SBS-offline SBS-offline] installation.
 +
 
 +
===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/libsbsdig.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.
 +
 
 +
===Building and installing the library===
 +
 
 +
in the library directory, type '''make'''.
 +
 
 +
A 'cmake' build is under development, but not ready yet.
 +
 
 +
==Useful links==
 +
 
 +
*[http://git-scm.com/documentation Git Documentation]
 +
*[https://github.com/JeffersonLab/libsbsdig Github.com] homepage for libsbsdig
 +
*[https://github.com/JeffersonLab/analyzer Github.com] and [https://redmine.jlab.org/projects/podd/wiki wiki] homepages for the analyzer
 +
*[[Documentation of SBS-offline]]

Latest revision as of 12:24, 6 March 2020

Documentation of libsbsdig: 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 libsbsdig on github.

Purpose

This page documents the libsbsdig code, which purpose is to transform the output data from G4SBS to digital values such as ADCs or TDCs. These produce files which can be analyzed with SBS-offline.

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 installation. libsbsdig is compatible with analyzer versions 1.6 and beyond.
  • Working SBS-offline installation.

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/libsbsdig.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.

Building and installing the library

in the library directory, type make.

A 'cmake' build is under development, but not ready yet.

Useful links