diff --git a/FAQ.md b/FAQ.md index 303155c..11b71e0 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1,3 +1,7 @@ # Frequently Asked Questions -* The event builder crashed, what do I do? +* **The event builder crashed, what do I do?** If the event builder crashes, first check the terminal for any crash information. Most commonly the event builder in GUI mode crashes due to a ROOT window error. If this is the case, one can simply re-open the event builder and everything should be fine. If the event builder crashed while analyzing a run, make sure to clean out the `temp_binary` directory of the workspace (it won't have reached the point in the code at which it automatically is wiped) otherwise errors will occur. If the event builder crashes due to a segmentation violation, a simple fix can sometimes be achieved by running the commands `make clean && make` to rebuild the repository from scratch. This is sometimes necessary after changes are made to the code. + +* **The event builder has been running progressively more slowly, and the data doesn't make any sense, what do I do?** As stated before, there are rare cases (crashes, unexpected shutdown, etc.) where the `temp_binary` directory of the workspace will not be cleaned. The code analyzes every file found in `temp_binary`, so as one might expect the compounding data files can lead to undefined behavior. If this is not the case, check your window size, particularly the slow window. Too large or too small (extremes) can lead to strange behavior, as none of the data will be built together (case of too small) or the data will all be lumped into a few built events (case of too large). In general the slow window should be around 1.5 to 3 us, as it is pretty much entirely dominated by the delay lines. + +* **I run the event builder and nothing happens, and there are no errors reported to the terminal. What is wrong?** This is most likely due to the event builder being unable to locate the raw binary archive you are trying to analyze. The event builder searches the `raw_binary` directory for a file with a name formmated as `run_#.tar.gz`, where `#` is the run number. Make sure that your file is actually in `raw_binary` and has the correct name format, and is a `.tar.gz` archive. Otherwise, make sure that the files in your run are CoMPASS `.bin` binary files with the correct file name format given by the CoMPASS software. Note that it has happened in the past where CoMPASS has slightly changed the file name format and this can sometimes lead to issues.