SPS_SABRE_EventBuilder/README.md

# SPS-SABRE Data Analysis Package
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.

## Installation
To build and install the event builder, the CMake build system is used. To build, simply run the following commands from the SPS_SABRE_EventBuilder directory:
```
mkdir build
cd build
cmake ..
make
```

To clone the repository use `git clone --recursive https://github.com/sesps/SPS_SABRE_EventBuilder.git`. If you're using the devel branch be sure to specify this with the `--branch` flag. The recursive flag is important; this tells github to pull all submodules associated with the repository. 

The binaries are installed to the `bin` directory of the event builder, and should be run from the event builder directory (i.e. `./bin/EventBuilderGui`). THe `bin` directory also contains a shell script named `archivist` for transferring data from a CoMPASS project to the
event builder workspace.

In general, one should only build for Release (this is the default), for maximum optimization. However, it can be useful to run in Debug (change the cmake command to `cmake -DCMAKE_BUILD_TYPE_DEBUG ..`) when testing new features.

## EventBuilder vs. EventBuilderGui
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.

## Details
For more information see the [wiki](https://github.com/sesps/SPS_SABRE_EventBuilder/wiki), which describes the app in much more detail.
Additionally, check the [FAQ](https://github.com/sesps/SPS_SABRE_EventBuilder/wiki/FAQ) if you're having trouble with something.

## System Requirements
- Requires C++17
- Requires ROOT version which supports CMake dictionary generation and is C++17 compatible
- Requires CMake >= 3.16
- This version is for data from CAEN CoMPASS >= 2.0. Data from older CoMPASS versions are not compatible.
First commit 2021-07-13 16:36:41 -04:00			`# SPS-SABRE Data Analysis Package`
Modified README to reflect CMake install instructions 2021-12-15 11:31:49 -05:00			`Version 4`
First commit 2021-07-13 16:36:41 -04:00			`This is a software package designed to help experimenters analyze data from SPS-SABRE at FSU.`
Update README, gitignore 2022-10-01 22:21:25 -04:00			`It can convert CoMPASS data to ROOT, sort the data in time, build events, perform preliminary analysis, and provide basic plots.`
First commit 2021-07-13 16:36:41 -04:00
Modified README to reflect CMake install instructions 2021-12-15 11:31:49 -05:00			`## Installation`
Updating README 2022-06-22 15:13:32 -04:00			`To build and install the event builder, the CMake build system is used. To build, simply run the following commands from the SPS_SABRE_EventBuilder directory:`
			```
			`mkdir build`
			`cd build`
			`cmake ..`
			`make`
			```
Modified README to reflect CMake install instructions 2021-12-15 11:31:49 -05:00
Updated README to reflect change to Premake 2021-12-18 15:54:55 -05:00			To clone the repository use `git clone --recursive https://github.com/sesps/SPS_SABRE_EventBuilder.git`. If you're using the devel branch be sure to specify this with the `--branch` flag. The recursive flag is important; this tells github to pull all submodules associated with the repository.
Modified README to reflect CMake install instructions 2021-12-15 11:31:49 -05:00
Update README, gitignore 2022-10-01 22:21:25 -04:00			The binaries are installed to the `bin` directory of the event builder, and should be run from the event builder directory (i.e. `./bin/EventBuilderGui`). THe `bin` directory also contains a shell script named `archivist` for transferring data from a CoMPASS project to the
			`event builder workspace.`
Modified README to reflect CMake install instructions 2021-12-15 11:31:49 -05:00
Finish updating README 2022-06-22 15:16:44 -04:00			In general, one should only build for Release (this is the default), for maximum optimization. However, it can be useful to run in Debug (change the cmake command to `cmake -DCMAKE_BUILD_TYPE_DEBUG ..`) when testing new features.
Modified README to reflect CMake install instructions 2021-12-15 11:31:49 -05:00
Updated README to reflect change to Premake 2021-12-18 15:54:55 -05:00			`## EventBuilder vs. EventBuilderGui`
Modified README to reflect CMake install instructions 2021-12-15 11:31:49 -05:00			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.
First commit 2021-07-13 16:36:41 -04:00
Update README, gitignore 2022-10-01 22:21:25 -04:00			`## Details`
			`For more information see the [wiki](https://github.com/sesps/SPS_SABRE_EventBuilder/wiki), which describes the app in much more detail.`
			`Additionally, check the [FAQ](https://github.com/sesps/SPS_SABRE_EventBuilder/wiki/FAQ) if you're having trouble with something.`
First commit 2021-07-13 16:36:41 -04:00
			`## System Requirements`
Update README.md 2022-10-24 14:32:21 -04:00			`- Requires C++17`
			`- Requires ROOT version which supports CMake dictionary generation and is C++17 compatible`
Update README, gitignore 2022-10-01 22:21:25 -04:00			`- Requires CMake >= 3.16`
Update README.md 2022-10-24 14:32:21 -04:00			`- This version is for data from CAEN CoMPASS >= 2.0. Data from older CoMPASS versions are not compatible.`