Running DAQ Interface » History » Version 154

John Freeman, 03/30/2015 02:56 PM

1 58 John Freeman
2 58 John Freeman
3 96 John Freeman
4 96 John Freeman
5 49 Erik Blaufuss
h1. Getting help
6 1 John Freeman
7 78 John Freeman
If, after reading this document (in particular, the "Troubleshooting and FAQ" section) you run into issues, or have questions, please contact:
8 49 Erik Blaufuss
* DAQInterface
9 49 Erik Blaufuss
** John Freeman -
10 62 John Freeman
* RunControl
11 49 Erik Blaufuss
** Erik Blaufuss -
12 66 John Freeman
* Configuration Manager
13 1 John Freeman
** Jon Paley -
14 123 John Freeman
* TDU XML-RPC server
15 123 John Freeman
** Tom Dealtry -
16 1 John Freeman
17 102 Erik Blaufuss
h1. Logbook
18 102 Erik Blaufuss
19 102 Erik Blaufuss
Please document all changes, software updates, and operational activities to the ELog:
20 102 Erik Blaufuss
21 102 Erik Blaufuss
22 120 John Freeman
23 1 John Freeman
h1. Brief preliminaries
24 1 John Freeman
25 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.). 
26 49 Erik Blaufuss
27 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:
28 1 John Freeman
29 1 John Freeman
30 1 John Freeman
31 1 John Freeman
cd /data/lbnedaq/daqarea
32 1 John Freeman
source fireup
33 1 John Freeman
34 1 John Freeman
35 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. 
36 123 John Freeman
37 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.
38 123 John Freeman
39 123 John Freeman
h1. Killing, launching, and getting the status of the DAQ applications
40 123 John Freeman
41 126 John Freeman
h2. Getting the status
42 126 John Freeman
43 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:
44 123 John Freeman
** These applications all need to be running in order for the DAQ to work
45 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)
46 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)
47 123 John Freeman
48 123 John Freeman
In order to determine which DAQ applications are already running, use the following command:
49 1 John Freeman
50 1 John Freeman
51 49 Erik Blaufuss
lbnecmd check
52 1 John Freeman
53 1 John Freeman
54 138 John Freeman
You'll then see output similar to the following:
55 1 John Freeman
56 124 John Freeman
lbnecontrol: Available
57 124 John Freeman
CfgMgr: **Not Found**
58 124 John Freeman
DAQInterface: Available
59 124 John Freeman
TDUControl: **Not Found**
60 124 John Freeman
61 1 John Freeman
62 91 John Freeman
63 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.
64 49 Erik Blaufuss
65 124 John Freeman
h2. Cleanup: killing RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
66 1 John Freeman
67 152 John Freeman
As of March 30, 2015, a new script called "" can be run at the command line to kill the DAQ applications. In order to kill all four applications, one would run:
68 152 John Freeman
69 152 John Freeman
70 152 John Freeman -c -d -r -t
71 152 John Freeman
72 152 John Freeman
73 152 John Freeman
where each option corresponds to the killing of a particular application -- "-c" for the configuration manager, "-d" for DAQInterface, "-r" for RunControl, and "-t" for the TDU XML-RPC server. If only a subset of these four applications are running, then only use the relevant options -- e.g., simply run <code> -t </code> if the only application running is the TDU server. Running the script without any options at all will print out instructions similar to what you see here. Be aware that it's good etiquette to make sure someone's not currently using the DAQ before you start killing applications. 
74 152 John Freeman
75 153 John Freeman
For the previous instructions for killing the applications (still correct, though more work-intensive), click on "Show", below:
76 152 John Freeman
77 152 John Freeman
78 152 John Freeman
79 124 John Freeman
Killing RunControl has its own special syntax, and is simply:
80 1 John Freeman
81 109 Thomas Dealtry
82 124 John Freeman
lbnecmd kill
83 1 John Freeman
84 105 John Freeman
85 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:
86 105 John Freeman
87 105 John Freeman
88 124 John Freeman
ps aux | grep -v grep | grep -v emacs | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp -e tdu
89 105 John Freeman
90 1 John Freeman
91 140 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. 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.
92 152 John Freeman
93 105 John Freeman
94 124 John Freeman
h2. Launching RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
95 105 John Freeman
96 154 John Freeman
Also as of March 30, 2015, a new script called "" can be run at the command line to launch the DAQ applications. In order to launch all four applications, one would run:
97 154 John Freeman
98 154 John Freeman -c -t -r -d <daqinterface configuration file>
99 154 John Freeman
100 154 John Freeman
101 154 John Freeman
The options refer to the same applications as in the case of, and like, executing the script without any options will print out instructions. Be aware, however, that DAQInterface will not be launched if RunControl isn't already running. In practice, though, you can launch RunControl in the same command by preceding the DAQInterface option with the RunControl option -- so, if the configuration manager and the TDU server will already up and available, then one would only need to execute <code> -r -d <daqinterface configuration file></code> in order to have the full suite of DAQ applications available for use. 
102 154 John Freeman
103 154 John Freeman
Note that if an application of a given type is already running, will not launch a duplicate application, but will instead print a warning to the screen. 
104 154 John Freeman
105 154 John Freeman
For the previous instructions on how to launch the DAQ applications, still correct, but more detailed and labor-demanding, click on "Show" below:
106 154 John Freeman
107 154 John Freeman
108 154 John Freeman
109 124 John Freeman
h3. Launching RunControl
110 49 Erik Blaufuss
111 124 John Freeman
112 49 Erik Blaufuss
rm -f /tmp/  # (This should only be necessary if last RunControl session wasn't killed via "lbnecmd kill")
113 1 John Freeman
lbnecmd launch
114 1 John Freeman
115 61 John Freeman
116 151 John Freeman
h3. Launching DAQInterface
117 151 John Freeman
118 151 John Freeman
119 151 John Freeman
daqinterface -f <daqinterface file> &
120 151 John Freeman
121 1 John Freeman
122 1 John Freeman
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 "The DAQInterface configuration file" for more. 
123 1 John Freeman
124 154 John Freeman
Other "expert" arguments:
125 151 John Freeman
126 1 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> &
127 1 John Freeman
128 1 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.  "-c" refers to the host on which RunControl is running, and "-H" the host on which DAQInterface is running. 
129 141 John Freeman
130 154 John Freeman
131 154 John Freeman
If multiple users with different terminals wish to check the DAQ output, it is recommended to try:
132 1 John Freeman
133 82 John Freeman
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> >>~/DI.log 2>&1 &
134 1 John Freeman
135 1 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)
136 141 John Freeman
137 154 John Freeman
138 124 John Freeman
h3. Launching the configuration manager
139 1 John Freeman
140 1 John Freeman
Please see the "Starting up the CfgMgrApp on lbne35t-gateway01" section of Jon Paley's documentation here:
141 109 Thomas Dealtry
142 124 John Freeman
h3. Launching the TDU XMLRPC server
143 109 Thomas Dealtry
144 109 Thomas Dealtry
145 124 John Freeman
tdu -T -P 10001 -H localhost -r 50008 &
146 1 John Freeman
147 1 John Freeman
148 109 Thomas Dealtry
?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.
149 109 Thomas Dealtry
150 125 John Freeman
See [[Starting and using TDUControl]] for more details.
151 154 John Freeman
152 154 John Freeman
153 62 John Freeman
154 1 John Freeman
h1. Configuring and starting Runs
155 1 John Freeman
156 142 John Freeman
With the applications launched, you can take the DAQ system through the standard transitions to perform a DAQ run. The "ground state" of the DAQ is called the "stopped" state. Each successful transition brings the DAQ into a different state.  Described in more detail later, the chain of states (in quotes) and transitions (in italics) in the DAQ system can be represented as follows:
157 1 John Freeman
158 142 John Freeman
159 143 John Freeman
160 142 John Freeman
"stopped" -> _init_ -> "ready" -> _start_ -> "running" -> _pause_ -> "ready" -> _resume_ -> "running" -> _stop_ -> "ready" -> _terminate_ -> "stopped"
161 143 John Freeman
162 142 John Freeman
163 142 John Freeman
164 125 John Freeman
h2. Checking the state of the DAQ
165 127 John Freeman
166 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:
167 1 John Freeman
168 125 John Freeman
lbnecontrol: Available
169 125 John Freeman
CfgMgr: Available
170 125 John Freeman
DAQInterface: Available
171 125 John Freeman
TDUControl: Available
172 125 John Freeman
173 125 John Freeman
Run number: 797
174 125 John Freeman
Run configuration: ganglia_test
175 125 John Freeman
Run type: Test
176 125 John Freeman
daqint@localhost:5570 (synchronous): running
177 125 John Freeman
178 125 John Freeman
179 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. 
180 108 John Freeman
181 108 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:
182 117 John Freeman
183 108 John Freeman
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
184 1 John Freeman
185 142 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.
186 1 John Freeman
187 94 John Freeman
h2.  Selecting a run configuration and DAQ components
188 49 Erik Blaufuss
189 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.
190 1 John Freeman
191 49 Erik Blaufuss
h3. List and select a configuration:
192 1 John Freeman
193 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
194 49 Erik Blaufuss
195 1 John Freeman
lbnecmd listconfigs
196 1 John Freeman
197 143 John Freeman
This lists all available configs, as well as the current selected config (Note, default config is "No Config"):
198 49 Erik Blaufuss
199 49 Erik Blaufuss
Available configs (Name : description)
200 1 John Freeman
201 111 John Freeman
8xssp_with_nova_sync : Sorry, no description found.
202 111 John Freeman
6xssp_ext : Sorry, no description found.
203 111 John Freeman
2xssp_ssp01_led_ssp02_tstamp : Sorry, no description found.
204 111 John Freeman
demo : This is a demo.  Testing 1, 2, 3…
205 30 John Freeman
206 49 Erik Blaufuss
207 1 John Freeman
Current selected config: No Config
208 49 Erik Blaufuss
209 143 John Freeman
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:
210 49 Erik Blaufuss
211 49 Erik Blaufuss
lbnecmd setconfig demo
212 1 John Freeman
213 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.
214 1 John Freeman
215 49 Erik Blaufuss
h3. List and select DAQ components.
216 1 John Freeman
217 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
218 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.
219 1 John Freeman
220 49 Erik Blaufuss
To see the list of available DAQ components:
221 1 John Freeman
222 49 Erik Blaufuss
lbnecmd listdaqcomps
223 62 John Freeman
224 1 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
225 112 John Freeman
226 112 John Freeman
227 112 John Freeman
component01 (lbnedaq2:5205)
228 112 John Freeman
component02 (lbnedaq2:5206)
229 112 John Freeman
230 112 John Freeman
ssp08 (lbnedaq1:5214)
231 112 John Freeman
232 112 John Freeman
233 112 John Freeman
component01 (lbnedaq2:5205)
234 112 John Freeman
component02 (lbnedaq2:5206)
235 1 John Freeman
236 1 John Freeman
ssp08 (lbnedaq1:5214)
237 62 John Freeman
238 143 John Freeman
The components are shown by name, along with the requested host/port to run the component's corresponding BoardReaderMain process on. You can then select a list of DAQ components to use in the run:
239 1 John Freeman
240 1 John Freeman
lbnecmd setdaqcomps component0{1,2}
241 118 John Freeman
242 49 Erik Blaufuss
(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.
243 143 John Freeman
244 143 John Freeman
How to make a new component available to RunControl is described later in this document. 
245 29 John Freeman
246 91 John Freeman
h2. Initializing, starting, stopping and terminating a Run
247 1 John Freeman
248 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:
249 1 John Freeman
250 49 Erik Blaufuss
lbnecmd check
251 1 John Freeman
252 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.
253 1 John Freeman
254 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:
255 1 John Freeman
256 1 John Freeman
lbnecmd init daq
257 1 John Freeman
258 1 John Freeman
259 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
260 29 John Freeman
261 1 John Freeman
lbnecmd start daq
262 49 Erik Blaufuss
263 127 John Freeman
Note that the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command:
264 49 Erik Blaufuss
265 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:
266 22 John Freeman
267 21 John Freeman
lbnecmd pause daq
268 42 John Freeman
269 41 John Freeman
270 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:
271 1 John Freeman
272 48 John Freeman
lbnecmd resume daq
273 48 John Freeman
274 48 John Freeman
275 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
276 48 John Freeman
277 48 John Freeman
lbnecmd stop daq
278 49 Erik Blaufuss
279 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
280 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:
281 1 John Freeman
282 67 Erik Blaufuss
283 67 Erik Blaufuss
lbnecmd terminate daq
284 67 Erik Blaufuss
285 1 John Freeman
286 49 Erik Blaufuss
h2. After your DAQ run.
287 1 John Freeman
288 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":
289 119 John Freeman
290 72 John Freeman
291 72 John Freeman
Config name: demo
292 72 John Freeman
Component #0: component01
293 1 John Freeman
Component #1: component02
294 119 John Freeman
lbne-artdaq commit: 0f0f9be1c63a3b487170579c887ce79944eca6f8
295 119 John Freeman
lbnerc commit: 92935f2702c5e0aa732fd3cc9ff6758e1a0c288c
296 119 John Freeman
/data/lbnedaq/config/ commit: 97d8b222742a41d5d10ea942a063ddfacac3ce93
297 1 John Freeman
298 114 John Freeman
299 114 John Freeman
pmt logfile(s): lbnedaq3:/data/lbnedaq/daqlogs/pmt/pmt-25771*.log
300 1 John Freeman
301 1 John Freeman
boardreader logfiles: 
302 1 John Freeman
303 1 John Freeman
304 1 John Freeman
305 1 John Freeman
eventbuilder logfiles: 
306 1 John Freeman
307 1 John Freeman
308 1 John Freeman
309 1 John Freeman
310 1 John Freeman
aggregator logfiles: 
311 1 John Freeman
312 1 John Freeman
313 1 John Freeman
314 1 John Freeman
315 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. 
316 1 John Freeman
317 119 John Freeman
318 129 John Freeman
{{collapse(Comprehensive details on the contents of the run records directory...)
319 129 John Freeman
320 129 John Freeman
** The full contents of the metadata file, beyond what's described above, include: 
321 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
322 129 John Freeman
-The individual artdaq process logfiles
323 129 John Freeman
324 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. 
325 129 John Freeman
326 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. 
327 129 John Freeman
328 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. 
329 129 John Freeman
330 129 John Freeman
331 129 John Freeman
332 129 John Freeman
{{collapse(How to examine your output Root files...)
333 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.
334 76 John Freeman
335 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:
336 76 John Freeman
337 76 John Freeman
338 76 John Freeman
cd <lbne-artdaq basedir>
339 76 John Freeman
source setupLBNEARTDAQ
340 76 John Freeman
rawEventDump -s <rootfile> -n <max events>
341 76 John Freeman
342 76 John Freeman
343 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:
344 76 John Freeman
345 76 John Freeman
346 81 John Freeman
%MSG-i MF_INIT_OK:  art 01-Dec-2014 16:13:59 CST JobSetup 
347 76 John Freeman
Messagelogger initialization complete.
348 76 John Freeman
349 81 John Freeman
%MSG-i PathConfiguration:  art 01-Dec-2014 16:14:00 CST JobSetup 
350 76 John Freeman
Multiple end paths have been combined into one end path,
351 76 John Freeman
"end_path" since order is irrelevant.
352 76 John Freeman
353 76 John Freeman
354 81 John Freeman
01-Dec-2014 16:14:00 CST  Initiating request to open file /tmp/lbne35t_r000270_sr01_20141201T221127.root
355 81 John Freeman
01-Dec-2014 16:14:00 CST  Successfully opened file /tmp/lbne35t_r000270_sr01_20141201T221127.root
356 1 John Freeman
357 76 John Freeman
Package             |Version             |Timestamp           
358 81 John Freeman
artdaq-core         |v1_04_06            |01-Dec-2014 21:59:51 UTC
359 81 John Freeman
artdaq              |v1_12_04            |01-Dec-2014 22:01:57 UTC
360 81 John Freeman
lbne-artdaq         |v0_00_08            |01-Dec-2014 22:00:18 UTC
361 81 John Freeman
lbne-artdaq         |v0_07_00            |01-Dec-2014 22:02:57 UTC
362 76 John Freeman
363 81 John Freeman
Begin processing the 1st record. run: 270 subRun: 1 event: 1 at 01-Dec-2014 16:14:00 CST
364 76 John Freeman
365 81 John Freeman
DAQ......... | daq........... | TOY1................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...2
366 1 John Freeman
DAQAG....... | TriggerResults | ..................... | art::TriggerResults.......... | art::TriggerResults.. | ...-
367 76 John Freeman
368 81 John Freeman
Total products (present, not present): 8 (2, 6).
369 76 John Freeman
370 1 John Freeman
371 76 John Freeman
DAQAG....... | BuildInfo... | LbneArtdaq........... | std::vector<artdaq::PackageBuildInfo> | artdaq::PackageBuildInfos | ...4
372 1 John Freeman
373 1 John Freeman
Total products (present, not present): 1 (1, 0).
374 76 John Freeman
375 76 John Freeman
01-Dec-2014 16:14:00 CST  Closed file /tmp/lbne35t_r000270_sr01_20141201T221127.root
376 76 John Freeman
377 81 John Freeman
TrigReport ---------- Event  Summary ------------
378 76 John Freeman
TrigReport Events total = 1 passed = 1 failed = 0
379 76 John Freeman
380 76 John Freeman
TrigReport ------ Modules in End-Path: end_path ------------
381 76 John Freeman
TrigReport  Trig Bit#    Visited     Passed     Failed      Error Name
382 76 John Freeman
TrigReport     0    0          1          1          0          0 printBuildInfo
383 76 John Freeman
TrigReport     0    0          1          1          0          0 out1
384 76 John Freeman
385 76 John Freeman
TimeReport ---------- Time  Summary ---[sec]----
386 76 John Freeman
TimeReport CPU = 0.003361 Real = 0.003000
387 76 John Freeman
388 1 John Freeman
Art has completed and will exit with status 0.
389 1 John Freeman
390 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.
391 129 John Freeman
392 129 John Freeman
393 131 John Freeman
h1. The DAQInterface configuration file
394 1 John Freeman
395 145 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. The default DAQInterface configuration file is docs/config.txt (relative to /data/lbnedaq/daqarea/lbnerc); if you wish to change parameters, it's considered best practice not to edit this default file but rather to copy it to a file of the form "<code>docs/config_<your username>.txt</code>", and edit that file, passing it to the DAQInterface executable via the "-f" option as described earlier in this document. 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; it should look something like the following:
396 1 John Freeman
397 1 John Freeman
398 100 John Freeman
lbne-artdaq: /data/lbnedaq/daqarea/lbne-artdaq-base/build_lbne-artdaq
399 91 John Freeman
400 1 John Freeman
PMT host: lbnedaq3
401 100 John Freeman
PMT port: 5400
402 1 John Freeman
403 49 Erik Blaufuss
pause before initialization: 5
404 49 Erik Blaufuss
405 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
406 49 Erik Blaufuss
debug level: 1
407 49 Erik Blaufuss
408 49 Erik Blaufuss
log directory:   /data/lbnedaq/daqlogs
409 49 Erik Blaufuss
410 91 John Freeman
record directory: /data/lbnedaq/run_records
411 49 Erik Blaufuss
412 116 John Freeman
# If this file is "config.txt" -- i.e., the standard, non-expert,
413 116 John Freeman
# non-testing version of the DAQInterface configuration file -- do not
414 116 John Freeman
# set "disable configuration check" to "true"
415 116 John Freeman
416 101 John Freeman
disable configuration check: false
417 101 John Freeman
418 101 John Freeman
TDU XMLRPC port: 0
419 91 John Freeman
420 91 John Freeman
EventBuilder host: lbnedaq2
421 48 John Freeman
EventBuilder port: 5235
422 91 John Freeman
423 91 John Freeman
EventBuilder host: lbnedaq2
424 91 John Freeman
EventBuilder port: 5236
425 48 John Freeman
426 91 John Freeman
Aggregator host: lbnedaq2
427 91 John Freeman
Aggregator port: 5265
428 48 John Freeman
429 91 John Freeman
Aggregator host: lbnedaq2
430 1 John Freeman
Aggregator port: 5266
431 1 John Freeman
432 1 John Freeman
433 1 John Freeman
434 130 John Freeman
The parameters you're most likely to change will be the following:
435 1 John Freeman
436 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.
437 1 John Freeman
438 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. 
439 130 John Freeman
440 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. 
441 130 John Freeman
442 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":
443 130 John Freeman
444 130 John Freeman
{{collapse(Other parameters are as follows…)
445 130 John Freeman
446 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
447 92 John Freeman
* *PMT port* : pmt.rb's port
448 116 John Freeman
449 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
450 93 John Freeman
451 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/
452 1 John Freeman
453 101 John Freeman
* *record directory* : the directory to which metadata about the run (FHiCL documents used, DAQInterface configuration file used, etc.) gets sent
454 101 John Freeman
455 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.
456 130 John Freeman
457 49 Erik Blaufuss
458 57 John Freeman
h1. Adding new configurations to RunControl
459 57 John Freeman
460 132 John Freeman
{{collapse(Expand for info here…)
461 132 John Freeman
462 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. 
463 68 John Freeman
464 91 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are edited within the directory
465 57 John Freeman
466 57 John Freeman
467 57 John Freeman
468 57 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
469 57 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
470 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")
471 59 John Freeman
472 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.
473 59 John Freeman
474 1 John Freeman
 event_builder_count: PLACEHOLDER
475 59 John Freeman
476 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.
477 1 John Freeman
478 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
479 68 John Freeman
480 68 John Freeman
git log
481 68 John Freeman
482 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:
483 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:
484 68 John Freeman
485 68 John Freeman
# On branch master
486 68 John Freeman
# Changes to be committed:
487 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
488 68 John Freeman
489 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
490 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
491 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
492 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
493 68 John Freeman
494 68 John Freeman
495 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.:
496 68 John Freeman
497 1 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
498 68 John Freeman
499 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. 
500 68 John Freeman
501 68 John Freeman
Now, make sure that the commit took place correctly by running
502 68 John Freeman
503 68 John Freeman
git diff HEAD
504 68 John Freeman
505 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
506 1 John Freeman
507 68 John Freeman
git log
508 68 John Freeman
509 69 John Freeman
you should be able to see your commit at the top.
510 57 John Freeman
511 79 John Freeman
* Finally, make sure to push your change to the central repository; to do this, simply execute
512 79 John Freeman
513 79 John Freeman
git push origin
514 79 John Freeman
515 79 John Freeman
516 79 John Freeman
and now, if you run 
517 79 John Freeman
518 79 John Freeman
519 79 John Freeman
git diff origin/master
520 79 John Freeman
521 1 John Freeman
522 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.
523 132 John Freeman
524 79 John Freeman
525 56 Erik Blaufuss
h1. Adding new DAQ Components to RunControl
526 49 Erik Blaufuss
527 133 John Freeman
{{collapse(Expand for info here…)
528 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
529 49 Erik Blaufuss
530 49 Erik Blaufuss
531 18 John Freeman
532 55 Erik Blaufuss
Each entry (name: host port) defines:
533 55 Erik Blaufuss
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
534 49 Erik Blaufuss
* host - hostname where BoardReader process will be started
535 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
536 18 John Freeman
537 49 Erik Blaufuss
For example:
538 49 Erik Blaufuss
539 49 Erik Blaufuss
component01: lbnedaq2 5205
540 49 Erik Blaufuss
component02: lbnedaq2 5206
541 49 Erik Blaufuss
542 49 Erik Blaufuss
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
543 133 John Freeman
544 133 John Freeman
*Note* that you will need to kill and re-launch RunControl if you add a component
545 133 John Freeman
546 27 John Freeman
547 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
548 28 John Freeman
549 49 Erik Blaufuss
h2.  Common RunControl issues
550 27 John Freeman
551 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
552 1 John Freeman
553 49 Erik Blaufuss
554 49 Erik Blaufuss
lbnecmd help
555 49 Erik Blaufuss
556 50 Erik Blaufuss
will list all available commands for RunControl with some details for help.  
557 50 Erik Blaufuss
558 1 John Freeman
h3.  No real configurations are listed by RunControl
559 45 John Freeman
560 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
561 45 John Freeman
562 49 Erik Blaufuss
Available configs (Name : description)
563 49 Erik Blaufuss
564 49 Erik Blaufuss
dummy : Dummy description
565 45 John Freeman
566 49 Erik Blaufuss
Instead of your expected configurations, RunControl is not able to connect to CfgMgr.  Please make sure it's running (
567 1 John Freeman
568 1 John Freeman
h2.  Common DAQInterface issues
569 147 John Freeman
570 147 John Freeman
As a preliminary: if something goes wrong when running the DAQ, there are two valuable sources of information:
571 148 John Freeman
# The pmt logfile(s), containing the output of the artdaq processes (including the output of the Art modules run within them -- so, for example, an exception throw from within a module would appear here). Where to find these logfiles is described in the section "After your DAQ run", earlier in this wiki. 
572 148 John Freeman
# The RunControl logfile, /home/lbnedaq/.lbnerc.log . This contains both the information sent from DAQInterface to RunControl, as well as diagnostic logging (such as the traceback of exception throws within DAQInterface)
573 1 John Freeman
574 146 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "<code>pmt.rb -p <port number> was already running on <hostname></code>"*
575 146 John Freeman
576 146 John Freeman
An instance of artdaq's Process Management Tool program, tasked with creating the artdaq processes, is already running on the host and port you've requested for it in the DAQInterface configuration file passed to the DAQInterface application. This can happen if, for example, the DAQInterface program from a previous session was killed off before the usual "lbnecmd terminate daq" transition was issued, a transition which prompts DAQInterface to kill off the pmt.rb process it has control over. Generally, DAQInterface will clean this up and free the port in the process of returning itself to the "stopped" state, but in case it doesn't, there's a script called "" which can be used in the following manner:
577 146 John Freeman
578 150 John Freeman
/data/lbnedaq/bin/ <pmt host> <pmt port>
579 146 John Freeman
580 146 John Freeman
581 149 John Freeman
This script will both kill off the pmt.rb which is clogging the port, as well as the artdaq processes over which it has control.
582 146 John Freeman
583 146 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
584 146 John Freeman
585 146 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.
586 146 John Freeman
587 146 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*
588 146 John Freeman
589 146 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.
590 146 John Freeman
591 146 John Freeman
{{collapse(Of developer interest)
592 1 John Freeman
h3.  *Error handling*
593 1 John Freeman
594 1 John Freeman
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
595 1 John Freeman
# An artdaq process returns an error state after a transition request, or an exception is thrown by the XML-RPC library during the request
596 1 John Freeman
# During periodic checks, one or more artdaq processes expected to exist are not found
597 1 John Freeman
598 1 John Freeman
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). 
599 51 John Freeman
600 84 John Freeman
h3. *Your change to the DAQInterface configuration file or the code doesn't seem to do anything*
601 77 John Freeman
602 77 John Freeman
Make sure you kill the existing daqinterface process and restart it
603 1 John Freeman
604 146 John Freeman