Installation

Installation

Cory R. Thornsberry

Last updated: September 11, 2019

• Required Prerequisites:

  • CMake version 2.8 or later is known to work
  • ROOT version 6 or later is recommended

• Recommended Prerequisites:

  • ncurses version 5 or greater (required for online-mode)
    • sudo apt-get install libncurses5-dev on Ubuntu

git clone https://github.com/cthornsb/SimplePixieScan ./SimpleScan
cd SimpleScan
mkdir build
cd build

Common SimpleScan install options are shown in the table below

OPTION	DEFAULT	DESCRIPTION
CMAKE_INSTALL_PREFIX	SimpleScan/install	Specifies the install directory for binaries, libraries, and headers
USE_NCURSES	ON	Build SimpleScan with interactive terminal support (required for online-mode)
BUILD_SHARED	OFF	Install shared libraries and headers so they may be used by other programs
BUILD_TOOLS	OFF	Install optional tool programs (below)
BUILD_TOOLS_CALIBRATE	OFF	Build and install detector calibration tool
BUILD_TOOLS_CMBINNER	ON	Center-of-mass angular binning tool
BUILD_TOOLS_BARIFIER	ON	High level dual sided detector analyzer
BUILD_TOOLS_MAPREADER	OFF	Tool to generate a map file from a SimpleScan output root file
BUILD_TOOLS_PHASEPHASE	OFF	Program to plot a start phase vs. a stop time
BUILD_TOOLS_RAWEVENT	OFF
BUILD_TOOLS_SPECFITTER	ON	Generic spectrum fitter program
BUILD_TOOLS_TIMEALIGN	ON	Time spectrum calibrator
BUILD_TOOLS_TRACER	OFF	Plots traces for a specific channel
BUILD_TOOLS_INSTANTTIME	OFF	Analyzer for logic and pulser signals
BUILD_TOOLS_ANGLEANALYZER	OFF
BUILD_TOOLS_CHISQUARE	OFF	Chi-square minimizer tool
BUILD_TOOLS_PSPMT	OFF	Position sensitive PSPMT detector analyzer

Install options may be set using ccmake e.g.

cmake ..
ccmake ..

or by passing options to CMake using the command line e.g.

cmake -DCMAKE_INSTALL_PREFIX=/path/to/install -DBUILD_TOOLS=ON ..

and so forth. Once CMake has successfully generated the makefile, simply type

make install

to compile and install

Installing the Module File

By default, cmake will install binaries to

SimpleScan/install/bin

This may be changed by modifying the CMake install prefix as described above. If you prefer to use the module file, you must copy the module file to one of your module paths.

cp install/share/modulefiles/simpleScan ${PATH_TO_MODULE_FILES}

Where PATH_TO_MODULE_FILES is dependent upon the configuration of your machine. You can check for the path by typing

module avail

For example, on my machine, the syntax would be

cp install/share/modulefiles/simpleScan /usr/share/modules/modulefiles/

Whenever you want to use SimpleScan, load the module by typing

module load simpleScan

Updating the Source Code

In the SimpleScan/ directory type

git pull
cd build/
make install

Barring a substantial change in the structure of the source code, this should be sufficient for keeping your install up-to-date with the repository.