Project

General

Profile

Running DAQ Interface » History » Version 126

John Freeman, 03/25/2015 01:19 PM

1 125 John Freeman
* UNDER REVISION AS OF 1:00 PM CDT, MARCH 25 -- PLEASE CONTACT JOHN FREEMAN, jcfree@fnal.gov, FOR MORE INFO
2 122 John Freeman
3 122 John Freeman
4 58 John Freeman
{{toc}}
5 58 John Freeman
6 96 John Freeman
!DAQ_communication_diagram4.png!
7 96 John Freeman
8 49 Erik Blaufuss
h1. Getting help
9 1 John Freeman
10 78 John Freeman
If, after reading this document (in particular, the "Troubleshooting and FAQ" section) you run into issues, or have questions, please contact:
11 49 Erik Blaufuss
* DAQInterface
12 49 Erik Blaufuss
** John Freeman - jcfree@fnal.gov
13 62 John Freeman
* RunControl
14 49 Erik Blaufuss
** Erik Blaufuss - blaufuss@icecube.umd.edu
15 66 John Freeman
* Configuration Manager
16 1 John Freeman
** Jon Paley - jpaley@anl.gov
17 123 John Freeman
* TDU XML-RPC server
18 123 John Freeman
** Tom Dealtry - thomas.dealtry@physics.ox.ac.uk
19 1 John Freeman
20 102 Erik Blaufuss
h1. Logbook
21 102 Erik Blaufuss
22 102 Erik Blaufuss
Please document all changes, software updates, and operational activities to the ELog:
23 102 Erik Blaufuss
24 102 Erik Blaufuss
http://dbweb3.fnal.gov:8080/ECL/lbne_35t
25 120 John Freeman
26 1 John Freeman
h1. Brief preliminaries
27 1 John Freeman
28 123 John Freeman
This guide assumes you have access to the LBNE 35 ton gateway node, lbne35t-gateway01.fnal.gov . 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, etc.). 
29 49 Erik Blaufuss
30 123 John Freeman
The installed code is located at lbne35t-gateway01.fnal.gov:/data/lbnedaq/daqarea/lbnerc. If you need access to the lbnedaq@lbne35t-gateway01.fnal.gov account, please contact one of the people listed above. To get started, login and first setup the environment:
31 1 John Freeman
32 1 John Freeman
<pre>
33 1 John Freeman
ssh lbnedaq@lbne35t-gateway01.fnal.gov
34 1 John Freeman
cd /data/lbnedaq/daqarea
35 1 John Freeman
source fireup
36 1 John Freeman
</pre>
37 1 John Freeman
38 123 John Freeman
This will take you into the /data/lbnedaq/daqarea/lbnerc directory, out of which the DAQ is controlled. 
39 123 John Freeman
40 123 John Freeman
Finally, when you see a <pre>…</pre> in example output, that is to be interpreted as a placeholder for output which is considered irrelevant to the point being explained.
41 123 John Freeman
42 123 John Freeman
h1. Killing, launching, and getting the status of the DAQ applications
43 123 John Freeman
44 126 John Freeman
h2. Getting the status
45 126 John Freeman
46 123 John Freeman
The DAQ application suite consists of RunControl, the configuration manager, DAQInterface (the component which intermediates between RunControl, the configuration manager, and the artdaq processes) and the XML-RPC server for the TDU (the program which allows a sync pulse to be sent to the hardware at the start of DAQ running). The following points about these programs should be observed:
47 123 John Freeman
** These applications all need to be running in order for the DAQ to work
48 123 John Freeman
** DAQInterface needs to be launched _after_ RunControl, and unlike the other applications, if a DAQInterface process is already found to be running on login, it shouldn't be used, but rather, killed and restarted (unless someone is actively using the DAQ already, of course)
49 123 John Freeman
** The actual names of the processes are "lbnecontrol" (RunControl), "daqinterface" (DAQInterface), "CfgMgrApp" (the configuration manager) and "tdu" (the TDU XML-RPC server)
50 123 John Freeman
51 123 John Freeman
In order to determine which DAQ applications are already running, use the following command:
52 1 John Freeman
53 1 John Freeman
<pre>
54 49 Erik Blaufuss
lbnecmd check
55 1 John Freeman
</pre>
56 1 John Freeman
57 124 John Freeman
This will display the current state of DAQInterface and RunControl. For example:
58 49 Erik Blaufuss
<pre>
59 1 John Freeman
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
60 124 John Freeman
lbnecontrol: Available
61 124 John Freeman
CfgMgr: **Not Found**
62 124 John Freeman
DAQInterface: Available
63 124 John Freeman
TDUControl: **Not Found**
64 124 John Freeman
...
65 1 John Freeman
</pre>
66 91 John Freeman
67 124 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 will now be described...
68 49 Erik Blaufuss
69 124 John Freeman
70 49 Erik Blaufuss
<pre>
71 124 John Freeman
ps aux | grep -v grep | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp -e tdu
72 1 John Freeman
</pre>
73 1 John Freeman
74 124 John Freeman
If you wish to kill any of these processes (described in the next section), the PID (process ID) to use is supplied as the second field in each row returned by the "ps aux" command.
75 61 John Freeman
76 124 John Freeman
h2. Cleanup: killing RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
77 1 John Freeman
78 124 John Freeman
Killing RunControl has its own special syntax, and is simply:
79 1 John Freeman
80 109 Thomas Dealtry
<pre>
81 124 John Freeman
lbnecmd kill
82 1 John Freeman
</pre>
83 105 John Freeman
84 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:
85 105 John Freeman
86 105 John Freeman
<pre>
87 124 John Freeman
ps aux | grep -v grep | grep -v emacs | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp -e tdu
88 105 John Freeman
</pre>
89 110 John Freeman
90 124 John Freeman
For each application which exists, a row will appear, the second field of which is that application's process ID. Keep in mind, of course, that if these processes are running, it might mean that someone else is using the DAQ, or that someone else who's done using it forgot to clean up. As the 9th and 10th fields of the row of variables "ps aux" returns concern how long the program has been running, you can use these values as well as your best judgement, then, before deciding these processes are not in active use and killing them. 
91 105 John Freeman
92 124 John Freeman
h2. Launching RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
93 105 John Freeman
94 124 John Freeman
h3. Launching RunControl
95 49 Erik Blaufuss
96 49 Erik Blaufuss
<pre>
97 124 John Freeman
rm -f /tmp/lbnecontrol.pid  # (This should only be necessary if last RunControl session wasn't killed via "lbnecmd kill")
98 49 Erik Blaufuss
lbnecmd launch
99 1 John Freeman
</pre>
100 1 John Freeman
101 124 John Freeman
h3. Launching DAQInterface
102 61 John Freeman
103 1 John Freeman
<pre>
104 82 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> &
105 1 John Freeman
</pre>
106 82 John Freeman
Here, the "daqint" argument is arbitrary, and is the name you'll give the DAQInterface process in RunControl; the "5570" argument is the port off of which DAQInterface will run. The "-f <daqinterface file>" is optional; if left out, the lbnerc/docs/config.txt file will be used to configure DAQInterface, otherwise <daqinterface file> will be used. The DAQInterface configuration is not to be confused with run configurations handled by the configuration manager; see the section "Configuring DAQInterface" for more. 
107 82 John Freeman
108 82 John Freeman
If multiple users with different terminals wish to check the DAQ output, it is recommended to try:
109 1 John Freeman
<pre>
110 82 John Freeman
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> >>~/DI.log 2>&1 &
111 1 John Freeman
</pre>
112 91 John Freeman
This will launch daqinterface in the background, with all messages being appended to the bottom of the file ~/DI.log  (The stdbuf -oL prevents buffering of output to the file, so the file should update in real time)
113 82 John Freeman
114 124 John Freeman
h3. Launching the configuration manager
115 1 John Freeman
116 1 John Freeman
Please see the "Starting up the CfgMgrApp on lbne35t-gateway01" section of Jon Paley's documentation here: https://cdcvs.fnal.gov/redmine/projects/fhicl_cfgmgr/wiki
117 109 Thomas Dealtry
118 124 John Freeman
h3. Launching the TDU XMLRPC server
119 109 Thomas Dealtry
120 109 Thomas Dealtry
<pre>
121 124 John Freeman
tdu -T 192.168.100.201 -P 10001 -H localhost -r 50008 &
122 109 Thomas Dealtry
</pre>
123 109 Thomas Dealtry
124 125 John Freeman
?Note that if you are using emulators, you don't need to run using the TDU. Remember to set 'TDU XMLRPC port' to less than or equal 0.
125 109 Thomas Dealtry
126 109 Thomas Dealtry
See [[Starting and using TDUControl]] for more details.
127 62 John Freeman
128 1 John Freeman
h1. Configuring and starting Runs
129 1 John Freeman
130 125 John Freeman
With the applications launched, you can take the DAQ system through the standard transitions to start a DAQ run.  
131 125 John Freeman
132 125 John Freeman
h2. Checking the state of the DAQ
133 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:
134 1 John Freeman
<pre>
135 125 John Freeman
lbnecontrol: Available
136 125 John Freeman
CfgMgr: Available
137 125 John Freeman
DAQInterface: Available
138 125 John Freeman
TDUControl: Available
139 125 John Freeman
140 125 John Freeman
Run number: 797
141 125 John Freeman
Run configuration: ganglia_test
142 125 John Freeman
Run type: Test
143 125 John Freeman
daqint@localhost:5570 (synchronous): running
144 125 John Freeman
</pre>
145 125 John Freeman
146 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. 
147 125 John Freeman
148 125 John Freeman
Note that you'll want to wait for a transition to complete before issuing another one, otherwise you'll receive a warning and the transition request will be ignored. DAQInterface will also report when transitions are complete -- e.g., at the end of the "initialize" transition, you'd see:
149 125 John Freeman
<pre>
150 1 John Freeman
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
151 108 John Freeman
</pre>
152 125 John Freeman
If a high "debug level" has been set for DAQInterface (see below for more on this), this message can get buried in a set of output messages; in this case "lbnecmd check" may be the easiest way to determine what state the system is in. Described in more detail later, the chain of states (in quotes) and transitions (in italics) in the DAQ system can be represented as follows:
153 108 John Freeman
154 108 John Freeman
---
155 117 John Freeman
156 108 John Freeman
"stopped" -> _init_ -> "ready" -> _start_ -> "running" -> _pause_ -> "ready" -> _resume_ -> "running" -> _stop_ -> "ready" -> _terminate_ -> "stopped"
157 1 John Freeman
158 108 John Freeman
---
159 1 John Freeman
160 94 John Freeman
h2.  Selecting a run configuration and DAQ components
161 49 Erik Blaufuss
162 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.
163 1 John Freeman
164 49 Erik Blaufuss
h3. List and select a configuration:
165 1 John Freeman
166 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
167 49 Erik Blaufuss
<pre>
168 49 Erik Blaufuss
lbnecmd listconfigs
169 1 John Freeman
</pre>
170 49 Erik Blaufuss
Will return a list of configs:
171 49 Erik Blaufuss
<pre>
172 49 Erik Blaufuss
Available configs (Name : description)
173 1 John Freeman
174 111 John Freeman
8xssp_with_nova_sync : Sorry, no description found.
175 111 John Freeman
6xssp_ext : Sorry, no description found.
176 111 John Freeman
2xssp_ssp01_led_ssp02_tstamp : Sorry, no description found.
177 111 John Freeman
demo : This is a demo.  Testing 1, 2, 3…
178 30 John Freeman
...
179 1 John Freeman
180 49 Erik Blaufuss
Current selected config: No Config
181 49 Erik Blaufuss
</pre>
182 111 John Freeman
This lists all available configs, as well as the current selected config (Note, default config is "No Config").  You can then select a configuration -- for the purposes of this tutorial, let's go with "demo", which creates simulated data without using any hardware:
183 49 Erik Blaufuss
<pre> 
184 49 Erik Blaufuss
lbnecmd setconfig demo
185 1 John Freeman
</pre>
186 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.
187 1 John Freeman
188 49 Erik Blaufuss
h3. List and select DAQ components.
189 1 John Freeman
190 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
191 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.
192 1 John Freeman
193 49 Erik Blaufuss
To see the list of available DAQ components:
194 1 John Freeman
<pre>
195 49 Erik Blaufuss
lbnecmd listdaqcomps
196 62 John Freeman
</pre>
197 1 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
198 112 John Freeman
<pre>
199 112 John Freeman
Available:
200 112 John Freeman
component01 (lbnedaq2:5205)
201 112 John Freeman
component02 (lbnedaq2:5206)
202 112 John Freeman
203 112 John Freeman
ssp08 (lbnedaq1:5214)
204 112 John Freeman
205 112 John Freeman
Selected:
206 112 John Freeman
component01 (lbnedaq2:5205)
207 112 John Freeman
component02 (lbnedaq2:5206)
208 112 John Freeman
209 1 John Freeman
ssp08 (lbnedaq1:5214)
210 62 John Freeman
</pre>
211 113 John Freeman
The components are shown by name, along with the requested host/port to run the BoardReaderMain process on. You can then select a list of DAQ components to use in the run:
212 1 John Freeman
<pre>
213 118 John Freeman
lbnecmd setdaqcomps component0{1,2}
214 49 Erik Blaufuss
</pre>
215 125 John Freeman
(n.b. the {1,2} in brackets is a Linux bash shell trick which expands <code>component0{1,2}</code> to <code>component01 component02</code>). This will return "OK" if successful ("lbnecmd listdaqcomps" will show this in the "selected" set of components).  If the specified components are not known, an error is returned.
216 49 Erik Blaufuss
To change the list of available components, see below.
217 29 John Freeman
218 91 John Freeman
h2. Initializing, starting, stopping and terminating a Run
219 1 John Freeman
220 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:
221 1 John Freeman
<pre>
222 49 Erik Blaufuss
lbnecmd check
223 1 John Freeman
</pre>
224 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.
225 1 John Freeman
226 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:
227 1 John Freeman
<pre>
228 1 John Freeman
lbnecmd init daq
229 1 John Freeman
</pre>
230 1 John Freeman
231 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
232 29 John Freeman
<pre>
233 1 John Freeman
lbnecmd start daq
234 29 John Freeman
</pre>
235 49 Erik Blaufuss
Note: the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command:
236 49 Erik Blaufuss
<pre>
237 49 Erik Blaufuss
lbnecmd check
238 49 Erik Blaufuss
lbnecontrol: running
239 49 Erik Blaufuss
Run number: 207
240 49 Erik Blaufuss
Run configuration: demo
241 1 John Freeman
242 49 Erik Blaufuss
daqint@localhost:5570 (synchronous): running
243 49 Erik Blaufuss
</pre>
244 49 Erik Blaufuss
245 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:
246 22 John Freeman
<pre>
247 21 John Freeman
lbnecmd pause daq
248 42 John Freeman
</pre>
249 41 John Freeman
250 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:
251 48 John Freeman
<pre>
252 48 John Freeman
lbnecmd resume daq
253 48 John Freeman
</pre>
254 48 John Freeman
255 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
256 48 John Freeman
<pre>
257 48 John Freeman
lbnecmd stop daq
258 49 Erik Blaufuss
</pre>
259 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
260 62 John Freeman
*NOTE* To select a new configuration or DAQ component set, you must kill all ArtDAQ processes and return DAQInterface to its "stopped" state with the "terminate" command:
261 1 John Freeman
262 1 John Freeman
<pre>
263 1 John Freeman
lbnecmd terminate daq
264 1 John Freeman
</pre>
265 67 Erik Blaufuss
266 67 Erik Blaufuss
If you want to stop all RunControl processes (known as "lbnecontrol"):
267 67 Erik Blaufuss
<pre>
268 67 Erik Blaufuss
lbnecmd kill
269 67 Erik Blaufuss
</pre>
270 67 Erik Blaufuss
After this, you will need to relaunch RunControl as above.
271 1 John Freeman
272 49 Erik Blaufuss
h2. After your DAQ run.
273 1 John Freeman
274 49 Erik Blaufuss
Once you've completed your run, there are a few things you can look at. 
275 48 John Freeman
276 76 John Freeman
h3. The DAQ log
277 76 John Freeman
278 114 John Freeman
A record of the DAQ's output will be saved in the subdirectory pmt/ relative to where you specified the output logfiles; thus given the "log directory" setting in the example DAQInterface configuration file below, you'd find the output in /data/lbnedaq/daqlogs/pmt/.
279 76 John Freeman
280 76 John Freeman
h3. The run record
281 76 John Freeman
282 91 John Freeman
Also, a record of the FHiCL documents sent to the artdaq processes, the configuration file used to control DAQInterface, and some further information will have been saved; as of this writing (12/3/14) the directory in which this can be found defaults to /data/lbnedaq/run_records/<run number>. 
283 92 John Freeman
** PLEASE NOTE that there may be slight differences between the saved FHiCL documents and the FHiCL documents specified in the DAQInterface configuration file (those that control the EventBuilderMain processes) and the run configuration (those that control the BoardReaderMain and AggregatorMain processes). The saved FHiCL document name is standardized to <processtype>_<host>_<port>_r<run number>.fcl, so, e.g, "EventBuilder_lbnedaq2_5235_r286.fcl" would be the saved name of /data/lbnedaq/fcl/EventBuilder_demo1.fcl, listed in the example DAQInterface configuration file above, assuming datataking was performed in run 286. 
284 1 John Freeman
** More importantly, the FHiCL document actually sent to the artdaq process may be slightly different than the FHiCL document provided for DAQInterface; 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). It is this post-bookkeeping FHiCL document which actually gets sent to the processes which gets saved to the output directory. 
285 115 John Freeman
** The "further information" mentioned above is stored in a file of the form "metadata_r<run number>.txt"; it includes the configuration chosen for the run, the components used, as well as the commit hashes for the lbne-artdaq, lbnerc, and configuration directory used. Also provided are the process management tool (PMT) and individual artdaq process logs; please note that as of this writing (3/19/15), while the algorithm used to determine these logs hasn't yet been incorrect, there are in-principle edge cases in which the wrong log could be provided, so be aware -- and in particular, check the line "Started run <runnumber>" in the PMT logfile for confirmation that you have what you want. 
286 115 John Freeman
287 119 John Freeman
As an example, in /data/lbnedaq/run_records/778 (the directory for run 778), the metadata file looks like the following:
288 72 John Freeman
<pre>
289 72 John Freeman
Config name: demo
290 72 John Freeman
Component #0: component01
291 1 John Freeman
Component #1: component02
292 119 John Freeman
lbne-artdaq commit: 0f0f9be1c63a3b487170579c887ce79944eca6f8
293 119 John Freeman
lbnerc commit: 92935f2702c5e0aa732fd3cc9ff6758e1a0c288c
294 119 John Freeman
/data/lbnedaq/config/ commit: 97d8b222742a41d5d10ea942a063ddfacac3ce93
295 114 John Freeman
296 114 John Freeman
297 119 John Freeman
pmt logfile(s): lbnedaq3:/data/lbnedaq/daqlogs/pmt/pmt-25771*.log
298 114 John Freeman
299 1 John Freeman
boardreader logfiles: 
300 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37365.log
301 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37366.log
302 114 John Freeman
303 114 John Freeman
eventbuilder logfiles: 
304 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37364.log
305 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37363.log
306 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37368.log
307 114 John Freeman
308 114 John Freeman
aggregator logfiles: 
309 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37369.log
310 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37367.log
311 119 John Freeman
312 1 John Freeman
</pre>
313 76 John Freeman
314 81 John Freeman
h3. Output of the Art modules
315 76 John Freeman
316 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.
317 76 John Freeman
318 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:
319 76 John Freeman
320 76 John Freeman
<pre>
321 76 John Freeman
cd <lbne-artdaq basedir>
322 76 John Freeman
source setupLBNEARTDAQ
323 76 John Freeman
rawEventDump -s <rootfile> -n <max events>
324 76 John Freeman
</pre>
325 76 John Freeman
326 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:
327 76 John Freeman
328 76 John Freeman
<pre>
329 81 John Freeman
%MSG-i MF_INIT_OK:  art 01-Dec-2014 16:13:59 CST JobSetup 
330 76 John Freeman
Messagelogger initialization complete.
331 76 John Freeman
%MSG
332 81 John Freeman
%MSG-i PathConfiguration:  art 01-Dec-2014 16:14:00 CST JobSetup 
333 76 John Freeman
Multiple end paths have been combined into one end path,
334 76 John Freeman
"end_path" since order is irrelevant.
335 76 John Freeman
336 76 John Freeman
%MSG
337 81 John Freeman
01-Dec-2014 16:14:00 CST  Initiating request to open file /tmp/lbne35t_r000270_sr01_20141201T221127.root
338 81 John Freeman
01-Dec-2014 16:14:00 CST  Successfully opened file /tmp/lbne35t_r000270_sr01_20141201T221127.root
339 1 John Freeman
--------------------------------------------------------------
340 76 John Freeman
Package             |Version             |Timestamp           
341 81 John Freeman
artdaq-core         |v1_04_06            |01-Dec-2014 21:59:51 UTC
342 81 John Freeman
artdaq              |v1_12_04            |01-Dec-2014 22:01:57 UTC
343 81 John Freeman
lbne-artdaq         |v0_00_08            |01-Dec-2014 22:00:18 UTC
344 81 John Freeman
lbne-artdaq         |v0_07_00            |01-Dec-2014 22:02:57 UTC
345 76 John Freeman
--------------------------------------------------------------
346 81 John Freeman
Begin processing the 1st record. run: 270 subRun: 1 event: 1 at 01-Dec-2014 16:14:00 CST
347 76 John Freeman
PROCESS NAME | MODULE LABEL.. | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE............ | PRODUCT FRIENDLY TYPE | SIZE
348 81 John Freeman
DAQ......... | daq........... | TOY1................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...2
349 1 John Freeman
DAQAG....... | TriggerResults | ..................... | art::TriggerResults.......... | art::TriggerResults.. | ...-
350 76 John Freeman
351 81 John Freeman
Total products (present, not present): 8 (2, 6).
352 76 John Freeman
353 1 John Freeman
PROCESS NAME | MODULE LABEL | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE.................... | PRODUCT FRIENDLY TYPE.... | SIZE
354 76 John Freeman
DAQAG....... | BuildInfo... | LbneArtdaq........... | std::vector<artdaq::PackageBuildInfo> | artdaq::PackageBuildInfos | ...4
355 76 John Freeman
356 76 John Freeman
Total products (present, not present): 1 (1, 0).
357 76 John Freeman
358 81 John Freeman
01-Dec-2014 16:14:00 CST  Closed file /tmp/lbne35t_r000270_sr01_20141201T221127.root
359 76 John Freeman
360 76 John Freeman
TrigReport ---------- Event  Summary ------------
361 76 John Freeman
TrigReport Events total = 1 passed = 1 failed = 0
362 76 John Freeman
363 76 John Freeman
TrigReport ------ Modules in End-Path: end_path ------------
364 76 John Freeman
TrigReport  Trig Bit#    Visited     Passed     Failed      Error Name
365 76 John Freeman
TrigReport     0    0          1          1          0          0 printBuildInfo
366 76 John Freeman
TrigReport     0    0          1          1          0          0 out1
367 76 John Freeman
368 76 John Freeman
TimeReport ---------- Time  Summary ---[sec]----
369 1 John Freeman
TimeReport CPU = 0.003361 Real = 0.003000
370 1 John Freeman
371 76 John Freeman
Art has completed and will exit with status 0.
372 76 John Freeman
</pre>
373 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.
374 81 John Freeman
375 84 John Freeman
h1. Configuring DAQInterface: the DAQInterface configuration file
376 91 John Freeman
377 92 John Freeman
DAQInterface has 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 before the DAQInterface process is started. It's expected that for normal operations, these should not need to changed too often, and alterations will be primarily of developer or expert interest. If you ARE a developer/expert or are simply curious, take a look at the default DAQInterface configuration file, found in docs/config.txt (relative to /data/lbnedaq/daqarea/lbnerc); it should look something like the following:
378 1 John Freeman
<pre>
379 1 John Freeman
380 100 John Freeman
lbne-artdaq: /data/lbnedaq/daqarea/lbne-artdaq-base/build_lbne-artdaq
381 91 John Freeman
382 1 John Freeman
PMT host: lbnedaq3
383 100 John Freeman
PMT port: 5400
384 1 John Freeman
385 49 Erik Blaufuss
pause before initialization: 5
386 49 Erik Blaufuss
387 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
388 49 Erik Blaufuss
debug level: 1
389 49 Erik Blaufuss
390 49 Erik Blaufuss
log directory:   /data/lbnedaq/daqlogs
391 49 Erik Blaufuss
392 91 John Freeman
record directory: /data/lbnedaq/run_records
393 49 Erik Blaufuss
394 116 John Freeman
# If this file is "config.txt" -- i.e., the standard, non-expert,
395 116 John Freeman
# non-testing version of the DAQInterface configuration file -- do not
396 116 John Freeman
# set "disable configuration check" to "true"
397 116 John Freeman
398 101 John Freeman
disable configuration check: false
399 101 John Freeman
400 101 John Freeman
TDU XMLRPC port: 0
401 91 John Freeman
402 91 John Freeman
EventBuilder host: lbnedaq2
403 48 John Freeman
EventBuilder port: 5235
404 91 John Freeman
405 91 John Freeman
EventBuilder host: lbnedaq2
406 91 John Freeman
EventBuilder port: 5236
407 48 John Freeman
408 91 John Freeman
Aggregator host: lbnedaq2
409 91 John Freeman
Aggregator port: 5265
410 48 John Freeman
411 91 John Freeman
Aggregator host: lbnedaq2
412 1 John Freeman
Aggregator port: 5266
413 1 John Freeman
414 1 John Freeman
</pre>
415 1 John Freeman
416 92 John Freeman
The meaning of these parameters is as follows:
417 92 John Freeman
418 92 John Freeman
* *lbne-artdaq* : the directory in which the desired build of lbne-artdaq to use is located
419 92 John Freeman
420 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
421 100 John Freeman
* *PMT port* : pmt.rb's port
422 92 John Freeman
423 92 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
424 1 John Freeman
425 92 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. 
426 92 John Freeman
427 116 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/
428 93 John Freeman
429 93 John Freeman
* *record directory* : the directory to which metadata about the run (FHiCL documents used, DAQInterface configuration file used, etc.) gets sent
430 101 John Freeman
431 1 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. 
432 101 John Freeman
433 101 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":https://cdcvs.fnal.gov/redmine/projects/lbne-daq/wiki/Starting_and_using_TDUControl
434 49 Erik Blaufuss
435 116 John Freeman
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.
436 49 Erik Blaufuss
437 57 John Freeman
h1. Adding new configurations to RunControl
438 57 John Freeman
439 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. 
440 68 John Freeman
441 91 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are edited within the directory
442 57 John Freeman
<pre>
443 57 John Freeman
/data/lbnedaq/config/<named_configuration>
444 57 John Freeman
</pre>
445 57 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
446 57 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
447 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")
448 59 John Freeman
449 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.
450 59 John Freeman
<pre>
451 1 John Freeman
 event_builder_count: PLACEHOLDER
452 59 John Freeman
</pre>
453 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.
454 1 John Freeman
455 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
456 68 John Freeman
<pre>
457 68 John Freeman
git log
458 68 John Freeman
</pre>
459 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:
460 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:
461 68 John Freeman
<pre>
462 68 John Freeman
# On branch master
463 68 John Freeman
# Changes to be committed:
464 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
465 68 John Freeman
#
466 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
467 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
468 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
469 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
470 68 John Freeman
#
471 68 John Freeman
</pre>
472 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.:
473 68 John Freeman
<pre>
474 1 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
475 68 John Freeman
</pre>
476 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. 
477 68 John Freeman
</pre>
478 68 John Freeman
Now, make sure that the commit took place correctly by running
479 68 John Freeman
<pre>
480 68 John Freeman
git diff HEAD
481 68 John Freeman
</pre>
482 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
483 1 John Freeman
<pre>
484 68 John Freeman
git log
485 68 John Freeman
</pre>
486 69 John Freeman
you should be able to see your commit at the top.
487 57 John Freeman
488 79 John Freeman
* Finally, make sure to push your change to the central repository; to do this, simply execute
489 79 John Freeman
<pre>
490 79 John Freeman
git push origin
491 79 John Freeman
</pre>
492 79 John Freeman
493 79 John Freeman
and now, if you run 
494 79 John Freeman
495 79 John Freeman
<pre>
496 79 John Freeman
git diff origin/master
497 79 John Freeman
</pre>
498 79 John Freeman
499 91 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. 
500 79 John Freeman
501 56 Erik Blaufuss
h1. Adding new DAQ Components to RunControl
502 49 Erik Blaufuss
503 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
504 49 Erik Blaufuss
<pre>
505 49 Erik Blaufuss
/home/lbnedaq/.lbnerc-components
506 18 John Freeman
</pre>
507 55 Erik Blaufuss
Each entry (name: host port) defines:
508 55 Erik Blaufuss
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
509 49 Erik Blaufuss
* host - hostname where BoardReader process will be started
510 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
511 18 John Freeman
512 49 Erik Blaufuss
For example:
513 49 Erik Blaufuss
<pre>
514 49 Erik Blaufuss
component01: lbnedaq2 5205
515 49 Erik Blaufuss
component02: lbnedaq2 5206
516 49 Erik Blaufuss
</pre>
517 49 Erik Blaufuss
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
518 27 John Freeman
519 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
520 28 John Freeman
521 49 Erik Blaufuss
h2.  Common RunControl issues
522 27 John Freeman
523 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
524 1 John Freeman
525 49 Erik Blaufuss
<pre>
526 49 Erik Blaufuss
lbnecmd help
527 49 Erik Blaufuss
</pre>
528 50 Erik Blaufuss
will list all available commands for RunControl with some details for help.  
529 50 Erik Blaufuss
 
530 1 John Freeman
h3.  No real configurations are listed by RunControl
531 45 John Freeman
532 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
533 45 John Freeman
<pre>
534 49 Erik Blaufuss
Available configs (Name : description)
535 49 Erik Blaufuss
536 49 Erik Blaufuss
dummy : Dummy description
537 45 John Freeman
</pre>
538 49 Erik Blaufuss
Instead of your expected configurations, RunControl is not able to connect to CfgMgr.  Please make sure it's running (https://cdcvs.fnal.gov/redmine/projects/fhicl_cfgmgr/wiki/Wiki)
539 1 John Freeman
540 49 Erik Blaufuss
h2.  Common DAQInterface issues
541 49 Erik Blaufuss
542 49 Erik Blaufuss
h3.  *Error handling*
543 49 Erik Blaufuss
544 49 Erik Blaufuss
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
545 49 Erik Blaufuss
# An artdaq process returns an error state after a transition request, or an exception is thrown by the XML-RPC library during the request
546 49 Erik Blaufuss
# During periodic checks, one or more artdaq processes expected to exist are not found
547 49 Erik Blaufuss
548 49 Erik Blaufuss
In either case, an error is reported via 0MQ to RunControl, and the "Recover" transition is automatically triggered. This transition is a fairly blunt instrument: it will kill any remaining artdaq processes and return DAQInterface to its original state of "stopped" (i.e., one in which it requires the "init" transition before anything else is done). 
549 49 Erik Blaufuss
550 84 John Freeman
h3. *Your change to the DAQInterface configuration file or the daqinterface.py code doesn't seem to do anything*
551 49 Erik Blaufuss
552 1 John Freeman
Make sure you kill the existing daqinterface process and restart it
553 49 Erik Blaufuss
554 54 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
555 49 Erik Blaufuss
556 91 John Freeman
If a "Recover" is triggered and you can see via "lbnecmd check" that DAQInterface is in the "stopped" state, try initializing again. If that doesn't work, you can try increasing the value of the "pause before initialization" variable in the DAQInterface configuration file. Empirically, it appears there needs to be a pause of at least 5 seconds before the FHiCL documents can be successfully sent via XML-RPC to the processes; increasing this value may make it less likely that the "Connection refused" error occurs.
557 54 John Freeman
558 49 Erik Blaufuss
h3. *On the initial transition, you see a regularly updating printout saying "Waiting for all processes to be launched"*
559 1 John Freeman
560 1 John Freeman
Seeing one or two of these is fine. If, after several seconds, something like the following
561 1 John Freeman
<pre>
562 1 John Freeman
Waiting for all processes to be launched; if zombie pmt.rb is running on localhost please kill it and this program (PID 31820)
563 1 John Freeman
</pre>
564 1 John Freeman
keeps getting output to screen, it means there's a problem initializing. In this case, the current (11/12/14) course of action is to externally kill DAQInterface using the PID listed; also, it's possible that there may already be a pmt.rb executable running on the desired host, blocking the launch of a new one due to a port conflict, in which case you should log onto the host (assuming you're not already on it), and run 
565 1 John Freeman
<pre>
566 1 John Freeman
ps aux | grep -v grep | grep pmt.rb 
567 51 John Freeman
</pre>
568 84 John Freeman
to see if this is the case. If it's not and you can't think of what might be wrong (is the configuration manager running? have you double-checked the DAQInterface configuration file?), then try increasing the debug level in the DAQInterface configuration file for your next run-through, as this will likely shed light on the nature of the problem.
569 77 John Freeman
570 77 John Freeman
h3. *Regardless of how high the debug level is set to, you don't see any output to screen when you issue transitions to DAQInterface*
571 1 John Freeman
572 79 John Freeman
Chances are that DAQInterface was started in another terminal, and consequently, it's in that terminal where output will appear. This issue can be circumvented by redirecting DAQInterface output into a file; how this can be accomplished is described elsewhere in this document.