Running DAQ Interface » History » Version 171

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