gwm17/SPS_SABRE_EventBuilder
1
0
Fork 0
mirror of https://github.com/sesps/SPS_SABRE_EventBuilder.git synced 2024-11-22 18:18:52 -05:00
Code Issues Projects Releases Wiki Activity

Modified README to reflect CMake install instructions

Browse Source
This commit is contained in:
Gordon McCann 2021-12-15 11:31:49 -05:00
parent b83374ea32
commit 1c6addb941
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,12 +1,23 @@
# SPS-SABRE Data Analysis Package
Version 3
Version 4
This is a software package designed to help experimenters analyze data from SPS-SABRE at FSU.
It can convert CoMPASS data to ROOT, sort the data in time, build events, perform preliminary analysis and provide basic plots. Programs are built using make, and a make file is included. Simply using the command make will build all programs.
WHEN TESTING, RUN WITH WIDE WINDOWS
## Installation
To install the event builder, the CMake build system is used. From the SPS_SABRE_EventBuilder directory first make a build directory:
`mkdir build`
Then, in the `build` directory, run the following command to build and install the release version of the event builder:
`cmake -DCMAKE_BUILD_TYPE=Release .. && make install`
This will compile and link all event builder programs and dependencies. The executables will be installed to the `bin` directory of the SPS_SABRE_EventBuilder directory, shared libraries for ROOT dictionaries will be in the `lib` directory (with necessary .pcm files), and the header files for the shared libraries will be installed to the `include` directory.
## GWMEVB vs. GWMEVB_CL
There are two programs provided. They are `GWMEVB` and `GWMEVB_CL`. The first is a full GUI version of the event builder. The GUI supports all conversion methods and the plotting tool.
There are two programs provided. They are `EventBuilderGui` and `EventBuilder`. The first is a full GUI version of the event builder. The GUI supports all conversion methods and the plotting tool.
### Building Events
The event building operation is the bulk of the analysis process. As files are being converted to ROOT from the raw CoMPASS binary, events are built using information given by the user.
@ -79,9 +90,4 @@ Currently the pipeline supports declaring individual digitizer channels as scale
## System Requirements
Only tested with `ROOT` 6.14, mileage may vary
Uses C++11 standards
Only compatible with MacOSX and Linux
## Compliling and Running
To compile use the command `make`
To clean run `make clean` and then run `make`
For a complete rebuild use `make clean_header` as well as `make clean`.
Only compatible with MacOSX and Linux