add README.md

This commit is contained in:
carina@hades 2022-10-31 21:53:29 -04:00
parent d63a53c3a6
commit 39fbf25219
2 changed files with 56 additions and 5 deletions

View File

@ -15,7 +15,7 @@ OBJS = programSetting.o triggerSummary.o registerSetting.o channelSettingPSD.o c
#########################################################################
all : test FSUDAQ test_indep EventBuilder
all : ../test ../FSUDAQ ../test_indep ../Analysis/EventBuilder
clean :
/bin/rm -f $(OBJS) test FSUDAQ test_indep EventBuilder FSUDAQDict.cxx *.pcm
@ -23,19 +23,19 @@ clean :
ClassDigitizer.o : ClassDigitizer.cpp ClassDigitizer.h RegisterAddress.h macro.h ClassData.h
$(CC) $(COPTS) -c ClassDigitizer.cpp
test : test.cpp ClassDigitizer.o
../test : test.cpp ClassDigitizer.o
@echo "--------- making test"
$(CC) $(COPTS) -o ../test test.cpp ClassDigitizer.o $(CAENLIBS) $(ROOTLIBS)
EventBuilder : EventBuilder.cpp ClassData.h
../Analysis/EventBuilder : EventBuilder.cpp ClassData.h
@echo "--------- making EventBuilder"
$(CC) $(COPTS) -o ../Analysis/EventBuilder EventBuilder.cpp $(ROOTLIBS)
test_indep : test_indep.cpp RegisterAddress.h macro.h
../test_indep : test_indep.cpp RegisterAddress.h macro.h
@echo "--------- making test_indep"
$(CC) $(COPTS) -o ../test_indep test_indep.cpp $(CAENLIBS)
FSUDAQ : FSUDAQDict.cxx $(OBJS) ClassData.h
../FSUDAQ : FSUDAQDict.cxx $(OBJS) ClassData.h
@echo "----------- creating FSUDAQ"
$(CC) $(COPTS) FSUDAQDict.cxx $(OBJS) -o ../FSUDAQ $(CAENLIBS) $(ROOTLIBS)
@ln -s -f DAQ/FSUDAQDict_rdict.pcm ../.

51
README.md Normal file
View File

@ -0,0 +1,51 @@
# Introduction
The FSUDAQ is a GUI, supports 1 CAEN x725 and x730 digitizer with either DPP-PHA or DPP-PSD firmware. It uses the CEAN ROOT for the Graphical Interface.
## Required Library
1. CAENComm 1.4+
2. CAENVMELib 2.5+
3. CAENDigitizer 2.12+
4. CAEN A3818 Driver 1.61+ (for optical link)
5. CERN ROOT 6
## Folder Structure
---FSUDAQ-+-DAQ
+-Analysis
+-(Symbolic link to data)-+-settings
+-FSUDAQ +-data
+-FSUDAQ.sh +-copy of FSUDAQ.sh
The parent folder FSUDAQ should be placed on the Home directory. The source code for the DAQ is inside the DAQ folder.
The key codes are :
1. ClassData.h
2. RegisterAddress.h
3. ClassDigitizer.h/cpp
The test.cpp is an example to use the above classes to control and readout digitizer.
The test_indep.cpp is an example to connect digitizer ONLY with CAEN library.
The rest of the files are for the GUI.
The Analysis folder stores all online analysis codes.
User should also make a symbolic link to the data folder.
The FSUDAQ.sh will be created when running the FSUDAQ for the 1st time. It stored the program settings.
## To Complie
Go to the DAQ folder:
> ~>cd FSUDAQ
> FSUDAQ>cd DAQ
> DAQ>make FSUDAQ
It will produce an executable FSUDAQ under the FSUDAQ, and FSUDAQDict_rdict.pcm.