Running DAQ Interface » History » Version 139

John Freeman, 03/25/2015 02:36 PM

1 125 John Freeman
2 122 John Freeman
3 122 John Freeman
4 58 John Freeman
5 58 John Freeman
6 96 John Freeman
7 96 John Freeman
8 49 Erik Blaufuss
h1. Getting help
9 1 John Freeman
10 78 John Freeman
If, after reading this document (in particular, the "Troubleshooting and FAQ" section) you run into issues, or have questions, please contact:
11 49 Erik Blaufuss
* DAQInterface
12 49 Erik Blaufuss
** John Freeman -
13 62 John Freeman
* RunControl
14 49 Erik Blaufuss
** Erik Blaufuss -
15 66 John Freeman
* Configuration Manager
16 1 John Freeman
** Jon Paley -
17 123 John Freeman
* TDU XML-RPC server
18 123 John Freeman
** Tom Dealtry -
19 1 John Freeman
20 102 Erik Blaufuss
h1. Logbook
21 102 Erik Blaufuss
22 102 Erik Blaufuss
Please document all changes, software updates, and operational activities to the ELog:
23 102 Erik Blaufuss
24 102 Erik Blaufuss
25 120 John Freeman
26 1 John Freeman
h1. Brief preliminaries
27 1 John Freeman
28 136 John Freeman
This guide assumes you have access to the lbnedaq account on the LBNE 35 ton gateway node, . It also assumes you have a rudimentary knowledge of how to navigate a bash environment in Linux (how to change directories, log onto different machines, perform time-ordered listings of files, edit a file using emacs or vi, etc.). 
29 49 Erik Blaufuss
30 137 John Freeman
The installed code is located at If you need access to the lbnedaq account, please contact one of the people listed above under "Getting Help". Once you have access, to get started, login and first setup the environment:
31 1 John Freeman
32 1 John Freeman
33 1 John Freeman
34 1 John Freeman
cd /data/lbnedaq/daqarea
35 1 John Freeman
source fireup
36 1 John Freeman
37 1 John Freeman
38 135 John Freeman
This will take you into the /data/lbnedaq/daqarea/lbnerc directory, out of which the DAQ is controlled. For the remainder of this wiki, the assumption is that you've already setup the environment using the above commands. 
39 123 John Freeman
40 134 John Freeman
Finally, when you see an ellipse ("…") in example output, that is to be interpreted as a placeholder for output which is considered irrelevant to the point being explained.
41 123 John Freeman
42 123 John Freeman
h1. Killing, launching, and getting the status of the DAQ applications
43 123 John Freeman
44 126 John Freeman
h2. Getting the status
45 126 John Freeman
46 123 John Freeman
The DAQ application suite consists of RunControl, the configuration manager, DAQInterface (the component which intermediates between RunControl, the configuration manager, and the artdaq processes) and the XML-RPC server for the TDU (the program which allows a sync pulse to be sent to the hardware at the start of DAQ running). The following points about these programs should be observed:
47 123 John Freeman
** These applications all need to be running in order for the DAQ to work
48 123 John Freeman
** DAQInterface needs to be launched _after_ RunControl, and unlike the other applications, if a DAQInterface process is already found to be running on login, it shouldn't be used, but rather, killed and restarted (unless someone is actively using the DAQ already, of course)
49 123 John Freeman
** The actual names of the processes are "lbnecontrol" (RunControl), "daqinterface" (DAQInterface), "CfgMgrApp" (the configuration manager) and "tdu" (the TDU XML-RPC server)
50 123 John Freeman
51 123 John Freeman
In order to determine which DAQ applications are already running, use the following command:
52 1 John Freeman
53 1 John Freeman
54 49 Erik Blaufuss
lbnecmd check
55 1 John Freeman
56 1 John Freeman
57 138 John Freeman
You'll then see output similar to the following:
58 1 John Freeman
59 124 John Freeman
lbnecontrol: Available
60 124 John Freeman
CfgMgr: **Not Found**
61 124 John Freeman
DAQInterface: Available
62 124 John Freeman
TDUControl: **Not Found**
63 124 John Freeman
64 1 John Freeman
65 91 John Freeman
66 138 John Freeman
Here, you see that RunControl and DAQInterface already exist, but the configuration manager and the TDU's XML-RPC server do not. In this case, you would not only want to launch the configuration manager and the server, but you would also want to kill and relaunch DAQInterface (again, assuming no-one else was actively using it). How to kill and launch applications is described in the next two sections.
67 49 Erik Blaufuss
68 124 John Freeman
69 124 John Freeman
h2. Cleanup: killing RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
70 1 John Freeman
71 124 John Freeman
Killing RunControl has its own special syntax, and is simply:
72 1 John Freeman
73 109 Thomas Dealtry
74 124 John Freeman
lbnecmd kill
75 1 John Freeman
76 105 John Freeman
77 124 John Freeman
The other DAQ applications, however, need to be killed via the standard Linux command <code>kill <pid></code>, where "<pid>" is the process ID of the application. To find the process IDs of all possible DAQ applications, you can run:
78 105 John Freeman
79 105 John Freeman
80 124 John Freeman
ps aux | grep -v grep | grep -v emacs | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp -e tdu
81 105 John Freeman
82 110 John Freeman
83 124 John Freeman
For each application which exists, a row will appear, the second field of which is that application's process ID. Keep in mind, of course, that if these processes are running, it might mean that someone else is using the DAQ, or that someone else who's done using it forgot to clean up. As the 9th and 10th fields of the row of variables "ps aux" returns concern how long the program has been running, you can use these values as well as your best judgement, then, before deciding these processes are not in active use and killing them. 
84 105 John Freeman
85 124 John Freeman
h2. Launching RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
86 105 John Freeman
87 124 John Freeman
h3. Launching RunControl
88 49 Erik Blaufuss
89 49 Erik Blaufuss
90 124 John Freeman
rm -f /tmp/  # (This should only be necessary if last RunControl session wasn't killed via "lbnecmd kill")
91 49 Erik Blaufuss
lbnecmd launch
92 1 John Freeman
93 1 John Freeman
94 124 John Freeman
h3. Launching DAQInterface
95 61 John Freeman
96 1 John Freeman
97 82 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> &
98 1 John Freeman
99 82 John Freeman
Here, the "daqint" argument is arbitrary, and is the name you'll give the DAQInterface process in RunControl; the "5570" argument is the port off of which DAQInterface will run. The "-f <daqinterface file>" is optional; if left out, the lbnerc/docs/config.txt file will be used to configure DAQInterface, otherwise <daqinterface file> will be used. The DAQInterface configuration is not to be confused with run configurations handled by the configuration manager; see the section "Configuring DAQInterface" for more. 
100 82 John Freeman
101 82 John Freeman
If multiple users with different terminals wish to check the DAQ output, it is recommended to try:
102 1 John Freeman
103 82 John Freeman
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> >>~/DI.log 2>&1 &
104 1 John Freeman
105 91 John Freeman
This will launch daqinterface in the background, with all messages being appended to the bottom of the file ~/DI.log  (The stdbuf -oL prevents buffering of output to the file, so the file should update in real time)
106 82 John Freeman
107 124 John Freeman
h3. Launching the configuration manager
108 1 John Freeman
109 1 John Freeman
Please see the "Starting up the CfgMgrApp on lbne35t-gateway01" section of Jon Paley's documentation here:
110 109 Thomas Dealtry
111 124 John Freeman
h3. Launching the TDU XMLRPC server
112 109 Thomas Dealtry
113 109 Thomas Dealtry
114 124 John Freeman
tdu -T -P 10001 -H localhost -r 50008 &
115 109 Thomas Dealtry
116 109 Thomas Dealtry
117 125 John Freeman
?Note that if you are using emulators, you don't need to run using the TDU. Remember to set 'TDU XMLRPC port' to less than or equal 0.
118 109 Thomas Dealtry
119 109 Thomas Dealtry
See [[Starting and using TDUControl]] for more details.
120 62 John Freeman
121 1 John Freeman
h1. Configuring and starting Runs
122 1 John Freeman
123 125 John Freeman
With the applications launched, you can take the DAQ system through the standard transitions to start a DAQ run.  
124 125 John Freeman
125 125 John Freeman
h2. Checking the state of the DAQ
126 127 John Freeman
127 125 John Freeman
At all stages, you can use the "lbnecmd check" command to see what state DAQInterface is in; example output of this is as follows:
128 1 John Freeman
129 125 John Freeman
lbnecontrol: Available
130 125 John Freeman
CfgMgr: Available
131 125 John Freeman
DAQInterface: Available
132 125 John Freeman
TDUControl: Available
133 125 John Freeman
134 125 John Freeman
Run number: 797
135 125 John Freeman
Run configuration: ganglia_test
136 125 John Freeman
Run type: Test
137 125 John Freeman
daqint@localhost:5570 (synchronous): running
138 125 John Freeman
139 125 John Freeman
140 125 John Freeman
Here, you've already seen how lbnecmd check can tell you whether a given application type has been launched or not; on the bottom line, however, you'll also see a description of the _state_ of the DAQ -- in this case, "running", meaning that it's actively acquiring data. 
141 125 John Freeman
142 125 John Freeman
Note that you'll want to wait for a transition to complete before issuing another one, otherwise you'll receive a warning and the transition request will be ignored. DAQInterface will also report when transitions are complete -- e.g., at the end of the "initialize" transition, you'd see:
143 125 John Freeman
144 1 John Freeman
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
145 108 John Freeman
146 125 John Freeman
If a high "debug level" has been set for DAQInterface (see below for more on this), this message can get buried in a set of output messages; in this case "lbnecmd check" may be the easiest way to determine what state the system is in. Described in more detail later, the chain of states (in quotes) and transitions (in italics) in the DAQ system can be represented as follows:
147 108 John Freeman
148 108 John Freeman
149 117 John Freeman
150 108 John Freeman
"stopped" -> _init_ -> "ready" -> _start_ -> "running" -> _pause_ -> "ready" -> _resume_ -> "running" -> _stop_ -> "ready" -> _terminate_ -> "stopped"
151 1 John Freeman
152 108 John Freeman
153 1 John Freeman
154 94 John Freeman
h2.  Selecting a run configuration and DAQ components
155 49 Erik Blaufuss
156 125 John Freeman
*Before initializing or starting a DAQ run*, a configuration and set of DAQ components must be selected.  This is done via RunControl.
157 1 John Freeman
158 49 Erik Blaufuss
h3. List and select a configuration:
159 1 John Freeman
160 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
161 49 Erik Blaufuss
162 49 Erik Blaufuss
lbnecmd listconfigs
163 1 John Freeman
164 49 Erik Blaufuss
Will return a list of configs:
165 49 Erik Blaufuss
166 49 Erik Blaufuss
Available configs (Name : description)
167 1 John Freeman
168 111 John Freeman
8xssp_with_nova_sync : Sorry, no description found.
169 111 John Freeman
6xssp_ext : Sorry, no description found.
170 111 John Freeman
2xssp_ssp01_led_ssp02_tstamp : Sorry, no description found.
171 111 John Freeman
demo : This is a demo.  Testing 1, 2, 3…
172 30 John Freeman
173 1 John Freeman
174 49 Erik Blaufuss
Current selected config: No Config
175 49 Erik Blaufuss
176 111 John Freeman
This lists all available configs, as well as the current selected config (Note, default config is "No Config").  You can then select a configuration -- for the purposes of this tutorial, let's go with "demo", which creates simulated data without using any hardware:
177 49 Erik Blaufuss
178 49 Erik Blaufuss
lbnecmd setconfig demo
179 1 John Freeman
180 90 John Freeman
This will return "OK" if successful; "lbnecmd listconfigs" will then show this as the current config.  If the specified configuration is not known, an error is returned. Instructions on how to add a configuration are given later in this document.
181 1 John Freeman
182 49 Erik Blaufuss
h3. List and select DAQ components.
183 1 John Freeman
184 62 John Freeman
You can select which portions of the LBNE DAQ setup you want to use in the upcoming run.  These are mapped generally to the ArtDAQ BoardReaderMain processes
185 90 John Freeman
that read them out.   As an operator, you need to ensure that there are configuration files available in the configuration manager for the DAQ Components that you select here, or DAQInterface will return an error.
186 1 John Freeman
187 49 Erik Blaufuss
To see the list of available DAQ components:
188 1 John Freeman
189 49 Erik Blaufuss
lbnecmd listdaqcomps
190 62 John Freeman
191 1 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
192 112 John Freeman
193 112 John Freeman
194 112 John Freeman
component01 (lbnedaq2:5205)
195 112 John Freeman
component02 (lbnedaq2:5206)
196 112 John Freeman
197 112 John Freeman
ssp08 (lbnedaq1:5214)
198 112 John Freeman
199 112 John Freeman
200 112 John Freeman
component01 (lbnedaq2:5205)
201 112 John Freeman
component02 (lbnedaq2:5206)
202 112 John Freeman
203 1 John Freeman
ssp08 (lbnedaq1:5214)
204 62 John Freeman
205 113 John Freeman
The components are shown by name, along with the requested host/port to run the BoardReaderMain process on. You can then select a list of DAQ components to use in the run:
206 1 John Freeman
207 118 John Freeman
lbnecmd setdaqcomps component0{1,2}
208 49 Erik Blaufuss
209 125 John Freeman
(n.b. the {1,2} in brackets is a Linux bash shell trick which expands <code>component0{1,2}</code> to <code>component01 component02</code>). This will return "OK" if successful ("lbnecmd listdaqcomps" will show this in the "selected" set of components).  If the specified components are not known, an error is returned.
210 49 Erik Blaufuss
To change the list of available components, see below.
211 29 John Freeman
212 91 John Freeman
h2. Initializing, starting, stopping and terminating a Run
213 1 John Freeman
214 66 John Freeman
For each of these transitions, please recall that while "lbnecmd <cmd>" returns very quickly, the actual issued command can take several seconds or minutes to complete.  Before issuing another command, be sure that the transition is complete by using the check command:
215 1 John Freeman
216 49 Erik Blaufuss
lbnecmd check
217 1 John Freeman
218 62 John Freeman
For example, before issuing the "start" transition, you can use this command to ensure that the DAQ is in the "ready" state and not still in the "initializing" stage.
219 1 John Freeman
220 92 John Freeman
First, take DAQInterface from the "stopped" to the "ready" state; this will create the artdaq processes on the hosts you selected (DAQ components), and initialize them with the FHiCL documents:
221 1 John Freeman
222 1 John Freeman
lbnecmd init daq
223 1 John Freeman
224 1 John Freeman
225 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
226 29 John Freeman
227 1 John Freeman
lbnecmd start daq
228 49 Erik Blaufuss
229 127 John Freeman
Note that the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command:
230 49 Erik Blaufuss
231 49 Erik Blaufuss
Pause the running of the DAQ, putting DAQInterface into the "paused" state.  This will cause the current open output file to be closed and given a name reflecting the current run number:
232 22 John Freeman
233 21 John Freeman
lbnecmd pause daq
234 42 John Freeman
235 41 John Freeman
236 1 John Freeman
Resume the running of the DAQ, putting returning to the "running" state.  This will restart data taking to a new output file:
237 1 John Freeman
238 48 John Freeman
lbnecmd resume daq
239 48 John Freeman
240 48 John Freeman
241 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
242 48 John Freeman
243 48 John Freeman
lbnecmd stop daq
244 49 Erik Blaufuss
245 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
246 127 John Freeman
*NOTE* To select a new configuration or DAQ component set, you must issue the "terminate" command, which will kill all ArtDAQ processes and return DAQInterface to its "stopped" state:
247 1 John Freeman
248 67 Erik Blaufuss
249 67 Erik Blaufuss
lbnecmd terminate daq
250 67 Erik Blaufuss
251 1 John Freeman
252 49 Erik Blaufuss
h2. After your DAQ run.
253 1 John Freeman
254 129 John Freeman
Once you've completed your run, there are typically two primary outputs: the Root files which contain the data which passed through the DAQ (saved, as of March 25, 2015, in /data/lbnedaq/data on the gateway node), and a set of text files containing information about the run. To access these text files, you'll want to go to the run records directory, which defaults to /data/lbnedaq/run_records/<run_number>. This directory contains the FHiCL documents used to control the ArtDAQ processes in the run, the DAQInterface configuration file used (described later in this wiki), and a metadata file, which, among other things, describes where to find a record of the DAQ's output. An example of this file, for run 778, can be found if we look in /data/lbnedaq/run_records/778 at "metadata_r778.txt":
255 119 John Freeman
256 72 John Freeman
257 72 John Freeman
Config name: demo
258 72 John Freeman
Component #0: component01
259 1 John Freeman
Component #1: component02
260 119 John Freeman
lbne-artdaq commit: 0f0f9be1c63a3b487170579c887ce79944eca6f8
261 119 John Freeman
lbnerc commit: 92935f2702c5e0aa732fd3cc9ff6758e1a0c288c
262 119 John Freeman
/data/lbnedaq/config/ commit: 97d8b222742a41d5d10ea942a063ddfacac3ce93
263 1 John Freeman
264 114 John Freeman
265 114 John Freeman
pmt logfile(s): lbnedaq3:/data/lbnedaq/daqlogs/pmt/pmt-25771*.log
266 1 John Freeman
267 1 John Freeman
boardreader logfiles: 
268 1 John Freeman
269 1 John Freeman
270 1 John Freeman
271 1 John Freeman
eventbuilder logfiles: 
272 1 John Freeman
273 1 John Freeman
274 1 John Freeman
275 1 John Freeman
276 1 John Freeman
aggregator logfiles: 
277 1 John Freeman
278 1 John Freeman
279 1 John Freeman
280 1 John Freeman
281 129 John Freeman
The most significant things saved in this file for the end user of the DAQ system are the configuration chosen and the components chosen for the run (at the top of the file), and the wildcard for the pmt (ArtDAQ Process Management Tool) logfiles, which contain the output of the DAQ system, under "pmt logfile(s)" -- so, in this case, executing <code>ls -ltr /data/lbnedaq/daqlogs/pmt/pmt-25771*.log</code> would list the files containing the output of the DAQ in run 778. 
282 1 John Freeman
283 119 John Freeman
284 129 John Freeman
{{collapse(Comprehensive details on the contents of the run records directory...)
285 129 John Freeman
286 129 John Freeman
** The full contents of the metadata file, beyond what's described above, include: 
287 129 John Freeman
-The git commit hashes of the lbne-artdaq and lbnerc packages used in the run, as well as the commit hash of the configuration directory used by the configuration manager
288 129 John Freeman
-The individual artdaq process logfiles
289 129 John Freeman
290 129 John Freeman
** A copy of the DAQInterface configuration file with a name of the format <code>config_r<run number>.txt</code> is saved. A description of what this file is comes later in the wiki. 
291 129 John Freeman
292 129 John Freeman
** Please note that the FHiCL documents saved in the run records directory will contain the actual FHiCL sent to the artdaq processes for the run, and that this will be slightly different than the contents of the FHiCL documents found in the configuration manager's directory. This is because DAQInterface performs some bookkeeping on FHiCL variables which account for things such as the number of processes of a given type (note that it makes no changes which would affect the physics). The saved FHiCL document name is standardized to <processtype>_<host>_<port>_r<run number>.fcl, so, e.g, "EventBuilder_lbnedaq2_5735_r778.fcl" refers to the FhiCL used to control the EventBuilderMain process on lbnedaq2 at port 5735 during run 778. 
293 129 John Freeman
294 129 John Freeman
** Please also note that the entire subdirectory for the configuration is also saved alongside the FHiCL documents; this is because some FHiCL documents are included via "#include" into the main FHiCL documents for a given process, and this was the way to save them as well as the main FHiCL documents. 
295 129 John Freeman
296 129 John Freeman
297 129 John Freeman
298 129 John Freeman
{{collapse(How to examine your output Root files...)
299 81 John Freeman
Various Art modules may create various types of output. In particular, it's standard for one of the two AggregatorMains running in an artdaq-based DAQ to use Art's RootOutput module, which will save the assembled raw event in an Art-readable *.root file. The location of this output can be found in the FHiCL code used to control RootOutput. The other AggregatorMain typically will run other RootOutput modules designed to create plots, diagnostic printouts, etc.; the nature of the output here is too varied to neatly summarize, but checking the FHiCL code used to control these Art modules should reveal their output location.
300 76 John Freeman
301 76 John Freeman
To take a quick look at the Art-readable *.root file, with a version of lbne-artdaq newer than 11/25/14, you can do the following:
302 76 John Freeman
303 76 John Freeman
304 76 John Freeman
cd <lbne-artdaq basedir>
305 76 John Freeman
source setupLBNEARTDAQ
306 76 John Freeman
rawEventDump -s <rootfile> -n <max events>
307 76 John Freeman
308 76 John Freeman
309 76 John Freeman
where here, <lbne-artdaq basedir> is the parent directory of the lbne-artdaq package, <rootfile> is the Art-readable *.root file produced in a given run, and <max events> is the max events whose info you wish to look at. The output of this command will look something like the following:
310 76 John Freeman
311 76 John Freeman
312 81 John Freeman
%MSG-i MF_INIT_OK:  art 01-Dec-2014 16:13:59 CST JobSetup 
313 76 John Freeman
Messagelogger initialization complete.
314 76 John Freeman
315 81 John Freeman
%MSG-i PathConfiguration:  art 01-Dec-2014 16:14:00 CST JobSetup 
316 76 John Freeman
Multiple end paths have been combined into one end path,
317 76 John Freeman
"end_path" since order is irrelevant.
318 76 John Freeman
319 76 John Freeman
320 81 John Freeman
01-Dec-2014 16:14:00 CST  Initiating request to open file /tmp/lbne35t_r000270_sr01_20141201T221127.root
321 81 John Freeman
01-Dec-2014 16:14:00 CST  Successfully opened file /tmp/lbne35t_r000270_sr01_20141201T221127.root
322 1 John Freeman
323 76 John Freeman
Package             |Version             |Timestamp           
324 81 John Freeman
artdaq-core         |v1_04_06            |01-Dec-2014 21:59:51 UTC
325 81 John Freeman
artdaq              |v1_12_04            |01-Dec-2014 22:01:57 UTC
326 81 John Freeman
lbne-artdaq         |v0_00_08            |01-Dec-2014 22:00:18 UTC
327 81 John Freeman
lbne-artdaq         |v0_07_00            |01-Dec-2014 22:02:57 UTC
328 76 John Freeman
329 81 John Freeman
Begin processing the 1st record. run: 270 subRun: 1 event: 1 at 01-Dec-2014 16:14:00 CST
330 76 John Freeman
331 81 John Freeman
DAQ......... | daq........... | TOY1................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...2
332 1 John Freeman
DAQAG....... | TriggerResults | ..................... | art::TriggerResults.......... | art::TriggerResults.. | ...-
333 76 John Freeman
334 81 John Freeman
Total products (present, not present): 8 (2, 6).
335 76 John Freeman
336 1 John Freeman
337 76 John Freeman
DAQAG....... | BuildInfo... | LbneArtdaq........... | std::vector<artdaq::PackageBuildInfo> | artdaq::PackageBuildInfos | ...4
338 1 John Freeman
339 1 John Freeman
Total products (present, not present): 1 (1, 0).
340 76 John Freeman
341 76 John Freeman
01-Dec-2014 16:14:00 CST  Closed file /tmp/lbne35t_r000270_sr01_20141201T221127.root
342 76 John Freeman
343 81 John Freeman
TrigReport ---------- Event  Summary ------------
344 76 John Freeman
TrigReport Events total = 1 passed = 1 failed = 0
345 76 John Freeman
346 76 John Freeman
TrigReport ------ Modules in End-Path: end_path ------------
347 76 John Freeman
TrigReport  Trig Bit#    Visited     Passed     Failed      Error Name
348 76 John Freeman
TrigReport     0    0          1          1          0          0 printBuildInfo
349 76 John Freeman
TrigReport     0    0          1          1          0          0 out1
350 76 John Freeman
351 76 John Freeman
TimeReport ---------- Time  Summary ---[sec]----
352 76 John Freeman
TimeReport CPU = 0.003361 Real = 0.003000
353 76 John Freeman
354 1 John Freeman
Art has completed and will exit with status 0.
355 1 John Freeman
356 76 John Freeman
The first thing you see here is the version and build time of the lbne-artdaq package and some of the main packages on which it depends. Then you see a listing of products in the root file, here including two fragments of type TOY1, produced by the ToySimulator fragment generator. Finally, a listing of passed events; the output here is the result of running with "-n 1" as an option, so as we'd expect there's only one event.
357 129 John Freeman
358 129 John Freeman
359 131 John Freeman
h1. The DAQInterface configuration file
360 1 John Freeman
361 131 John Freeman
DAQInterface uses some key information stored in a local configuration file, NOT to be confused with the run configuration described elsewhere on this wiki. Examples of this information are location and ports for artdaq processes, location of lbne-artdaq software, debug (log) level, etc). These can be changed while the DAQ is in its "stopped" state. It's expected that for normal operations, most parameters should not need to changed too often, and alterations will be primarily of developer or expert interest. If you ARE a developer/expert or are simply curious, take a look at the default DAQInterface configuration file, found in docs/config.txt (relative to /data/lbnedaq/daqarea/lbnerc); it should look something like the following:
362 1 John Freeman
363 1 John Freeman
364 100 John Freeman
lbne-artdaq: /data/lbnedaq/daqarea/lbne-artdaq-base/build_lbne-artdaq
365 91 John Freeman
366 1 John Freeman
PMT host: lbnedaq3
367 100 John Freeman
PMT port: 5400
368 1 John Freeman
369 49 Erik Blaufuss
pause before initialization: 5
370 49 Erik Blaufuss
371 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
372 49 Erik Blaufuss
debug level: 1
373 49 Erik Blaufuss
374 49 Erik Blaufuss
log directory:   /data/lbnedaq/daqlogs
375 49 Erik Blaufuss
376 91 John Freeman
record directory: /data/lbnedaq/run_records
377 49 Erik Blaufuss
378 116 John Freeman
# If this file is "config.txt" -- i.e., the standard, non-expert,
379 116 John Freeman
# non-testing version of the DAQInterface configuration file -- do not
380 116 John Freeman
# set "disable configuration check" to "true"
381 116 John Freeman
382 101 John Freeman
disable configuration check: false
383 101 John Freeman
384 101 John Freeman
TDU XMLRPC port: 0
385 91 John Freeman
386 91 John Freeman
EventBuilder host: lbnedaq2
387 48 John Freeman
EventBuilder port: 5235
388 91 John Freeman
389 91 John Freeman
EventBuilder host: lbnedaq2
390 91 John Freeman
EventBuilder port: 5236
391 48 John Freeman
392 91 John Freeman
Aggregator host: lbnedaq2
393 91 John Freeman
Aggregator port: 5265
394 48 John Freeman
395 91 John Freeman
Aggregator host: lbnedaq2
396 1 John Freeman
Aggregator port: 5266
397 1 John Freeman
398 1 John Freeman
399 1 John Freeman
400 130 John Freeman
The parameters you're most likely to change will be the following:
401 1 John Freeman
402 130 John Freeman
* *lbne-artdaq* : the directory in which the desired build of lbne-artdaq to use is located; you would change this if you'd modified and built a personal copy of lbne-artdaq for hardware troubleshooting purposes, for example.
403 1 John Freeman
404 130 John Freeman
* *debug level* : allows the user to set the verbosity level of the output to the screen; setting it to higher values creates greater verbosity, and as a practical matter, the range of settings is currently 0-3. Loosely speaking, "0" means minimal output (not much beyond simply announcing a transition is complete), "1" includes announcements of progress during transitions, "2" includes these announcements plus the values of certain variables as well as lbne-artdaq output, and "3" is primarily of developer interest. 
405 130 John Freeman
406 130 John Freeman
* *disable configuration check* : a boolean which can be set to "true" or "false"; normally this should be set to "false", which means that on the start transition, DAQInterface will intentionally fail and put itself into the "stopped" state if it discovers that edits have been made to the configuration directory since the last commit in that directory. If very frequent edits to the configuration directory are made during hardware debugging, however, switching this feature on to "true" can make life considerably easier. 
407 130 John Freeman
408 130 John Freeman
* *TDU XMLRPC port* : the value of the port through which DAQInterface will communicate with an XML-RPC server linked to the TDU. Needed for DAQInterface to send a sync pulse to the TDU at the beginning of the "start" and "resume" transitions. If this is set to 0 or a negative value, no sync pulse is attempted. For more on the TDU and its code, see Tom Dealtry's Wiki "here":
409 130 John Freeman
410 130 John Freeman
{{collapse(Other parameters are as follows…)
411 130 John Freeman
412 1 John Freeman
* *PMT host* : the host on which artdaq's process management tool script (pmt.rb, used by DAQInterface to launch and kill the artdaq processes) will run
413 92 John Freeman
* *PMT port* : pmt.rb's port
414 116 John Freeman
415 93 John Freeman
* *pause before initialization* : the time in seconds between when the artdaq processes have been created and when they're initialized via FHiCL documents; empirically a pause of 5 seconds seems to be sufficient (less than this an errors can occur; see below in the "Troubleshooting" section for more
416 93 John Freeman
417 101 John Freeman
* *log directory* : the directory relative to which lbne-artdaq's pmt/*.log output (a record of what it sent to stdout) will be placed, as well as the individual artdaq process logs, found in boardreader/, eventbuilder/, and aggregator/
418 1 John Freeman
419 101 John Freeman
* *record directory* : the directory to which metadata about the run (FHiCL documents used, DAQInterface configuration file used, etc.) gets sent
420 101 John Freeman
421 49 Erik Blaufuss
After these individual parameters, one defines the EventBuilderMain and AggregatorMain artdaq processes. Specifically, a process is defined in two lines, where each line should contain "EventBuilder" or "Aggregator", and then define the host and port on which the EventBuilderMain or AggregatorMain will run (to run an artdaq process on the same host as you're on, use "localhost"). Please note that the order of processes matters, and that they should be listed front-end to back-end, i.e., EventBuilders should appear before Aggregators.
422 130 John Freeman
423 49 Erik Blaufuss
424 57 John Freeman
h1. Adding new configurations to RunControl
425 57 John Freeman
426 132 John Freeman
{{collapse(Expand for info here…)
427 132 John Freeman
428 68 John Freeman
Adding a new configuration selectable from RunControl involves two steps: creating a directory with the desired name of the configuration which contains the desired FHiCL documents, and then committing that directory to the git repository. 
429 68 John Freeman
430 91 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are edited within the directory
431 57 John Freeman
432 57 John Freeman
433 57 John Freeman
434 57 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
435 57 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
436 57 John Freeman
* <named_component>_hw_cfg.fcl, used to initialize the BoardReaderMain process running the fragment generator associated with detector component "named_component". Note that there can be any number of such files associated with a configuration, as long as a given component is registered to RunControl (see below, "Adding new DAQ Components to RunControl")
437 59 John Freeman
438 59 John Freeman
There are existing examples of configurations currently within /data/lbnedaq/config which can be studied (and even copied) for further guidance; however, please disregard the "tmp1" and "tmp2" configurations. Note that the FHiCL documents in these directories contain some variables which are set to "PLACEHOLDER", e.g.
439 59 John Freeman
440 1 John Freeman
 event_builder_count: PLACEHOLDER
441 59 John Freeman
442 68 John Freeman
Note that this is not legal FHiCL, but that DAQInterface will substitute in the appropriate value before using the FHiCL document to initialize an artdaq process; here, for example, it would replace "PLACEHOLDER" with the actual number of EventBuilderMain processes being run.
443 1 John Freeman
444 68 John Freeman
Once you've added a new configuration to /data/lbnedaq/config, you'll need to perform a git commit. Essentially,  /data/lbnedaq/config is not merely a collection of directories naming configurations, but also a git repository. In fact, if you run
445 68 John Freeman
446 68 John Freeman
git log
447 68 John Freeman
448 68 John Freeman
you'll see a history of the commits made to the repository. In order to commit the directory, a couple of steps need to be taken:
449 68 John Freeman
* From /data/lbnedaq/config/, run <pre>git add <named_configuration></pre>. This will "stage" the directory to be committed. Running <pre>git status</pre> should show you something like the following:
450 68 John Freeman
451 68 John Freeman
# On branch master
452 68 John Freeman
# Changes to be committed:
453 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
454 68 John Freeman
455 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
456 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
457 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
458 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
459 68 John Freeman
460 68 John Freeman
461 68 John Freeman
* Next, run <pre>git commit -m "<commit message>"</pre>. The commit message should be your three initials followed by a colon, the name of the configuration followed by a colon, and then a brief description of the new configuration, including its name, e.g.:
462 68 John Freeman
463 1 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
464 68 John Freeman
465 68 John Freeman
Be aware of rules governing strings delimited by double quotes in bash -- i.e., don't try double quoting a word or phrase inside of your commit description. 
466 68 John Freeman
467 68 John Freeman
Now, make sure that the commit took place correctly by running
468 68 John Freeman
469 68 John Freeman
git diff HEAD
470 68 John Freeman
471 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
472 1 John Freeman
473 68 John Freeman
git log
474 68 John Freeman
475 69 John Freeman
you should be able to see your commit at the top.
476 57 John Freeman
477 79 John Freeman
* Finally, make sure to push your change to the central repository; to do this, simply execute
478 79 John Freeman
479 79 John Freeman
git push origin
480 79 John Freeman
481 79 John Freeman
482 79 John Freeman
and now, if you run 
483 79 John Freeman
484 79 John Freeman
485 79 John Freeman
git diff origin/master
486 79 John Freeman
487 1 John Freeman
488 132 John Freeman
you should again see no output. Pushing to the central repository is important as this is essentially the backup area for configurations; if a user accidentally overwrites something in /data/lbnedaq/config, as long as commits have been pushed to the central repository there will still be a saved record of configurations before the overwrites took place. In fact, as of this writing (12/3/14), if either (A) edits have been made to the /data/lbnedaq/config directory since its most recent commit, or (B) that commit hasn't been pushed to the central repository, DAQInterface will refuse to execute the initialize transition.
489 132 John Freeman
490 79 John Freeman
491 56 Erik Blaufuss
h1. Adding new DAQ Components to RunControl
492 49 Erik Blaufuss
493 133 John Freeman
{{collapse(Expand for info here…)
494 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
495 49 Erik Blaufuss
496 49 Erik Blaufuss
497 18 John Freeman
498 55 Erik Blaufuss
Each entry (name: host port) defines:
499 55 Erik Blaufuss
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
500 49 Erik Blaufuss
* host - hostname where BoardReader process will be started
501 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
502 18 John Freeman
503 49 Erik Blaufuss
For example:
504 49 Erik Blaufuss
505 49 Erik Blaufuss
component01: lbnedaq2 5205
506 49 Erik Blaufuss
component02: lbnedaq2 5206
507 49 Erik Blaufuss
508 49 Erik Blaufuss
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
509 133 John Freeman
510 133 John Freeman
*Note* that you will need to kill and re-launch RunControl if you add a component
511 133 John Freeman
512 27 John Freeman
513 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
514 28 John Freeman
515 49 Erik Blaufuss
h2.  Common RunControl issues
516 27 John Freeman
517 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
518 1 John Freeman
519 49 Erik Blaufuss
520 49 Erik Blaufuss
lbnecmd help
521 49 Erik Blaufuss
522 50 Erik Blaufuss
will list all available commands for RunControl with some details for help.  
523 50 Erik Blaufuss
524 1 John Freeman
h3.  No real configurations are listed by RunControl
525 45 John Freeman
526 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
527 45 John Freeman
528 49 Erik Blaufuss
Available configs (Name : description)
529 49 Erik Blaufuss
530 49 Erik Blaufuss
dummy : Dummy description
531 45 John Freeman
532 49 Erik Blaufuss
Instead of your expected configurations, RunControl is not able to connect to CfgMgr.  Please make sure it's running (
533 1 John Freeman
534 49 Erik Blaufuss
h2.  Common DAQInterface issues
535 49 Erik Blaufuss
536 49 Erik Blaufuss
h3.  *Error handling*
537 49 Erik Blaufuss
538 49 Erik Blaufuss
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
539 49 Erik Blaufuss
# An artdaq process returns an error state after a transition request, or an exception is thrown by the XML-RPC library during the request
540 49 Erik Blaufuss
# During periodic checks, one or more artdaq processes expected to exist are not found
541 49 Erik Blaufuss
542 49 Erik Blaufuss
In either case, an error is reported via 0MQ to RunControl, and the "Recover" transition is automatically triggered. This transition is a fairly blunt instrument: it will kill any remaining artdaq processes and return DAQInterface to its original state of "stopped" (i.e., one in which it requires the "init" transition before anything else is done). 
543 49 Erik Blaufuss
544 84 John Freeman
h3. *Your change to the DAQInterface configuration file or the code doesn't seem to do anything*
545 49 Erik Blaufuss
546 1 John Freeman
Make sure you kill the existing daqinterface process and restart it
547 49 Erik Blaufuss
548 54 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
549 49 Erik Blaufuss
550 91 John Freeman
If a "Recover" is triggered and you can see via "lbnecmd check" that DAQInterface is in the "stopped" state, try initializing again. If that doesn't work, you can try increasing the value of the "pause before initialization" variable in the DAQInterface configuration file. Empirically, it appears there needs to be a pause of at least 5 seconds before the FHiCL documents can be successfully sent via XML-RPC to the processes; increasing this value may make it less likely that the "Connection refused" error occurs.
551 54 John Freeman
552 49 Erik Blaufuss
h3. *On the initial transition, you see a regularly updating printout saying "Waiting for all processes to be launched"*
553 1 John Freeman
554 1 John Freeman
Seeing one or two of these is fine. If, after several seconds, something like the following
555 1 John Freeman
556 1 John Freeman
Waiting for all processes to be launched; if zombie pmt.rb is running on localhost please kill it and this program (PID 31820)
557 1 John Freeman
558 1 John Freeman
keeps getting output to screen, it means there's a problem initializing. In this case, the current (11/12/14) course of action is to externally kill DAQInterface using the PID listed; also, it's possible that there may already be a pmt.rb executable running on the desired host, blocking the launch of a new one due to a port conflict, in which case you should log onto the host (assuming you're not already on it), and run 
559 1 John Freeman
560 1 John Freeman
ps aux | grep -v grep | grep pmt.rb 
561 51 John Freeman
562 84 John Freeman
to see if this is the case. If it's not and you can't think of what might be wrong (is the configuration manager running? have you double-checked the DAQInterface configuration file?), then try increasing the debug level in the DAQInterface configuration file for your next run-through, as this will likely shed light on the nature of the problem.
563 77 John Freeman
564 77 John Freeman
h3. *Regardless of how high the debug level is set to, you don't see any output to screen when you issue transitions to DAQInterface*
565 1 John Freeman
566 79 John Freeman
Chances are that DAQInterface was started in another terminal, and consequently, it's in that terminal where output will appear. This issue can be circumvented by redirecting DAQInterface output into a file; how this can be accomplished is described elsewhere in this document.