Project

General

Profile

Wiki » History » Version 2

Gregory Rakness, 02/26/2019 11:55 AM

1 2 Gregory Rakness
h1. Mu2e otsdaq Tracker
2 1 Ryan Rivera
3 2 Gregory Rakness
h2. Quickstart instructions:
4 2 Gregory Rakness
5 2 Gregory Rakness
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 mu2e otsdaq Tracker interface code can be included.  
6 2 Gregory Rakness
7 2 Gregory Rakness
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,
8 2 Gregory Rakness
9 2 Gregory Rakness
<pre>
10 2 Gregory Rakness
cd $MRB_SOURCE # this is the 'srcs' directory that will be set in the course of setting up OTS-DAQ
11 2 Gregory Rakness
mrb gitCheckout -d otsdaq_mu2e ssh://p-mu2e-otsdaq@cdcvs.fnal.gov/cvs/projects/mu2e-otsdaq
12 2 Gregory Rakness
mrb gitCheckout -d pcie_linux_kernel_module ssh://p-pcie_linux_kernel_module@cdcvs.fnal.gov/cvs/projects/pcie_linux_kernel_module
13 1 Ryan Rivera
mrb gitCheckout -d otsdaq_mu2e_tracker ssh://p-mu2e-otsdaq-tracker@cdcvs.fnal.gov/cvs/projects/mu2e-otsdaq-tracker
14 2 Gregory Rakness
</pre>
15 2 Gregory Rakness
16 2 Gregory Rakness
Otherwise, you can just clone the directory using the http sever,
17 2 Gregory Rakness
18 2 Gregory Rakness
<pre>
19 2 Gregory Rakness
cd $MRB_SOURCE # this is the srcs directory that will be set in the course of setting up OTS-DAQ
20 2 Gregory Rakness
mrb gitCheckout -d otsdaq_mu2e_tracker http://cdcvs.fnal.gov/projects/mu2e-otsdaq-tracker
21 2 Gregory Rakness
</pre>
22 2 Gregory Rakness
23 2 Gregory Rakness
Alternatively, if you do not have mrb set up, you can check out the code using git directly,
24 2 Gregory Rakness
25 2 Gregory Rakness
<pre>
26 2 Gregory Rakness
git clone http://cdcvs.fnal.gov/projects/otsdaq_mu2e otsdaq_mu2e
27 2 Gregory Rakness
git clone http://cdcvs.fnal.gov/projects/pcie_linux_kernel_module pcie_linux_kernel_module
28 2 Gregory Rakness
git clone http://cdcvs.fnal.gov/projects/mu2e-otsdaq-tracker otsdaq_mu2e_tracker
29 2 Gregory Rakness
</pre>
30 2 Gregory Rakness
31 2 Gregory Rakness
If you don't checkout using ssh, you will not be able to push your changes to redmine.
32 2 Gregory Rakness
33 2 Gregory Rakness
Once the package is checked out or if you are starting a new session, source the environment,
34 2 Gregory Rakness
35 2 Gregory Rakness
<pre>
36 2 Gregory Rakness
source /path/to/products/area/setup # e.g. /data/ups/setup
37 2 Gregory Rakness
cd my/mrb/working/directory # this is where localProducts_otsdaq_* and srcs resides
38 2 Gregory Rakness
setup mrb
39 2 Gregory Rakness
setup git
40 2 Gregory Rakness
source local*/setup
41 2 Gregory Rakness
source mrbSetEnv
42 2 Gregory Rakness
</pre>
43 2 Gregory Rakness
44 2 Gregory Rakness
h2. Structure
45 2 Gregory Rakness
46 2 Gregory Rakness
Ideally, everything that is needed for a user to run OTSDAQ will be contained in the otsdaq_mu2e_calorimeter directory and the code in otsdaq, otsdaq_utilities, and otsdaq_components 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).
47 2 Gregory Rakness
48 2 Gregory Rakness
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.
49 2 Gregory Rakness
50 2 Gregory Rakness
h3. Interface
51 2 Gregory Rakness
52 2 Gregory Rakness
The FEInterface class tells OTSDAQ how to communicate with front end electronics and is found in <pre>otsdaq_mu2e_tracker/otsdaq-mu2e-tracker/FEInterfaces/</pre>.  All of the methods defined in the interface source can be called from the OTSDAQ web interface...
53 2 Gregory Rakness
54 2 Gregory Rakness
h2. Useful links
55 2 Gregory Rakness
56 2 Gregory Rakness
Wiki syntax "*Here*":https://cdcvs.fnal.gov/redmine/projects/fermi-redmine/wiki/RedmineWikiFormatting
57 2 Gregory Rakness
58 2 Gregory Rakness
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