Project

General

Profile

Wiki » History » Version 2

Lorenzo Uplegger, 02/07/2017 10:13 AM

1 1 Lorenzo Uplegger
h1. Template DAQ
2 1 Lorenzo Uplegger
3 1 Lorenzo Uplegger
4 1 Lorenzo Uplegger
h2. Quickstart instructions:
5 1 Lorenzo Uplegger
6 1 Lorenzo Uplegger
This code is an extension of the "*OTS-DAQ*":https://cdcvs.fnal.gov/redmine/projects/otsdaq project and requires it to function.  To setup OTS-DAQ use the instructions listed "*here*":https://cdcvs.fnal.gov/redmine/projects/otsdaq/wiki/Instructions_for_using_MRB_with_OTSDAQ for installing the core OTS-DAQ packages.  *This must be done first!*  Once the OTSDAQ core dependencies are set up, the CMS Outer Tracker interface code can be included.
7 1 Lorenzo Uplegger
8 1 Lorenzo Uplegger
If you are one of the project managers and plan on making modifications to the code, you can checkout the repository doing the following assuming you have valid kerberos credentials,
9 1 Lorenzo Uplegger
10 1 Lorenzo Uplegger
<pre>
11 1 Lorenzo Uplegger
cd $MRB_SOURCE # this is the 'srcs' directory that will be set in the course of setting up OTS-DAQ
12 1 Lorenzo Uplegger
mrb gitCheckout -d otsdaq_template ssh://p-template@cdcvs.fnal.gov/cvs/projects/template
13 1 Lorenzo Uplegger
</pre>
14 1 Lorenzo Uplegger
15 1 Lorenzo Uplegger
Otherwise, you can just clone the directory using the http sever,
16 1 Lorenzo Uplegger
17 1 Lorenzo Uplegger
<pre>
18 1 Lorenzo Uplegger
cd $MRB_SOURCE # this is the srcs directory that will be set in the course of setting up OTS-DAQ
19 1 Lorenzo Uplegger
mrb gitCheckout -d otsdaq_template http://cdcvs.fnal.gov/projects/template
20 1 Lorenzo Uplegger
</pre>
21 1 Lorenzo Uplegger
22 1 Lorenzo Uplegger
Alternatively, if you do not have mrb set up, you can check out the code using git directly,
23 1 Lorenzo Uplegger
24 1 Lorenzo Uplegger
<pre>
25 1 Lorenzo Uplegger
git clone http://cdcvs.fnal.gov/projects/template otsdaq_template
26 1 Lorenzo Uplegger
</pre>
27 1 Lorenzo Uplegger
28 1 Lorenzo Uplegger
If you don't checkout using ssh, you will not be able to push your changes to redmine.
29 1 Lorenzo Uplegger
30 1 Lorenzo Uplegger
Once the package is checked out or if you are starting a new session, source the environment,
31 1 Lorenzo Uplegger
32 1 Lorenzo Uplegger
<pre>
33 1 Lorenzo Uplegger
source /path/to/products/area/setup # e.g. /data/ups/setup
34 1 Lorenzo Uplegger
export OTS_DIR=my/mrb/working/directory
35 1 Lorenzo Uplegger
source /path/to/products/area/setup # e.g. /data/ups/setup
36 1 Lorenzo Uplegger
cd ${OTS_DIR} # this is where localProducts_otsdaq_* and srcs resides
37 1 Lorenzo Uplegger
setup mrb
38 1 Lorenzo Uplegger
setup git
39 1 Lorenzo Uplegger
source local*/setup
40 1 Lorenzo Uplegger
source mrbSetEnv
41 1 Lorenzo Uplegger
export USER_DATA=${OTS_DIR}/srcs/otsdaq_template/Data
42 1 Lorenzo Uplegger
export ARTDAQ_DATABASE_URI=filesystemdb://${OTS_DIR}/srcs/otsdaq_template/databases/filesystemdb/test_db
43 1 Lorenzo Uplegger
</pre>
44 1 Lorenzo Uplegger
45 1 Lorenzo Uplegger
h2. Structure
46 1 Lorenzo Uplegger
47 2 Lorenzo Uplegger
Ideally, everything that is needed for a user to run OTSDAQ will be contained in the otsdaq_template directory and the code in otsdaq and otsdaq_utilities will not need to be touched.  If there is a situation where you wish to modify part of the core code, it is advised to put in a request with one of the maintainers (Lorenzo, Ryan, or Eric).
48 1 Lorenzo Uplegger
49 1 Lorenzo Uplegger
Below is a summary of some of the parts that will need to be modified in order to set up communication with the experimental device.
50 1 Lorenzo Uplegger
51 1 Lorenzo Uplegger
h3. Interface
52 1 Lorenzo Uplegger
53 2 Lorenzo Uplegger
The FEInterface class tells OTSDAQ how to communicate with front end electronics and is found in <pre>otsdaq_template/otsdaq-template/FEInterfaces/</pre>.  All of the methods defined in the interface source can be called from the OTSDAQ web interface...
54 1 Lorenzo Uplegger
55 1 Lorenzo Uplegger
h3. Configuration
56 1 Lorenzo Uplegger
57 1 Lorenzo Uplegger
Configuration files are kept in <pre>otsdaq_template/databases</pre>.  
58 1 Lorenzo Uplegger
59 1 Lorenzo Uplegger
h3. Data management
60 1 Lorenzo Uplegger
61 1 Lorenzo Uplegger
...
62 1 Lorenzo Uplegger
63 1 Lorenzo Uplegger
64 1 Lorenzo Uplegger
h2. Useful links
65 1 Lorenzo Uplegger
66 1 Lorenzo Uplegger
Wiki syntax "*Here*":https://cdcvs.fnal.gov/redmine/projects/fermi-redmine/wiki/RedmineWikiFormatting
67 1 Lorenzo Uplegger
68 1 Lorenzo Uplegger
Instructions for setting up main version of OTSDAQ using MRB: "*Off-the-Shelf DAQ*":https://cdcvs.fnal.gov/redmine/projects/otsdaq/wiki/Instructions_for_using_MRB_with_OTSDAQ