Project

General

Profile

Running DAQ Interface » History » Version 121

John Freeman, 03/25/2015 11:59 AM

1 58 John Freeman
{{toc}}
2 58 John Freeman
3 96 John Freeman
!DAQ_communication_diagram4.png!
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 - jcfree@fnal.gov
10 62 John Freeman
* RunControl
11 49 Erik Blaufuss
** Erik Blaufuss - blaufuss@icecube.umd.edu
12 66 John Freeman
* Configuration Manager
13 66 John Freeman
** Jon Paley - jpaley@anl.gov
14 1 John Freeman
15 102 Erik Blaufuss
h1. Logbook
16 102 Erik Blaufuss
17 102 Erik Blaufuss
Please document all changes, software updates, and operational activities to the ELog:
18 102 Erik Blaufuss
19 102 Erik Blaufuss
http://dbweb3.fnal.gov:8080/ECL/lbne_35t
20 95 John Freeman
21 120 John Freeman
h1. Brief preliminaries
22 120 John Freeman
23 121 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.). 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.
24 120 John Freeman
25 1 John Freeman
h1. Starting DAQInterface and Run Control
26 1 John Freeman
27 66 John Freeman
The DAQ software, consisting of RunControl, the configuration manager and DAQInterface (as well as the artdaq processes it controls) is designed to be run on lbne35t-gateway01.fnal.gov, using the lbnedaq account. If you need access to the lbnedaq@lbne35t-gateway01.fnal.gov account, please contact one of us.
28 49 Erik Blaufuss
29 91 John Freeman
The installed code is located at lbne35t-gateway01.fnal.gov:/data/lbnedaq/daqarea/lbnerc. To get started, login and first setup the environment:
30 49 Erik Blaufuss
31 30 John Freeman
<pre>
32 33 John Freeman
ssh lbnedaq@lbne35t-gateway01.fnal.gov
33 91 John Freeman
cd /data/lbnedaq/daqarea
34 1 John Freeman
source fireup
35 1 John Freeman
</pre>
36 1 John Freeman
37 91 John Freeman
This will take you into the /data/lbnedaq/daqarea/lbnerc directory. It's a good idea to check whether lbnecontrol (the RunControl application), DAQInterface (the component which intermediates between RunControl, the configuration manager, and the artdaq processes) and the configuration manager are already running; if they are, the instructions below won't work. Also worth noting is that as of 11/21/14, attempts to use multiple DAQs (implying multiple instances of RunControl, DAQInterface, etc.) has not been attempted and likely will not work. To check for RunControl and DAQInterface, you can try:
38 1 John Freeman
39 1 John Freeman
<pre>
40 49 Erik Blaufuss
lbnecmd check
41 1 John Freeman
</pre>
42 1 John Freeman
43 61 John Freeman
This will display the current state of DAQInterface and RunControl. The example below shows that both RunControl and DAQInterface are running, but the DAQ run is in the stopped state:
44 49 Erik Blaufuss
<pre>
45 49 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
46 49 Erik Blaufuss
lbnecontrol: running
47 49 Erik Blaufuss
daqint@localhost:5770 (synchronous): stopped
48 49 Erik Blaufuss
</pre>
49 1 John Freeman
50 73 John Freeman
If RunControl is running, and at some point DAQInterface was running but has since been killed:
51 73 John Freeman
<pre>
52 73 John Freeman
lbnecontrol: running
53 73 John Freeman
daqint@localhost:5770 (synchronous): missing
54 73 John Freeman
</pre>
55 91 John Freeman
(In this case, just restart DAQInterface -- how to do this is described shortly).
56 73 John Freeman
57 49 Erik Blaufuss
If RunControl is not running, you'll see something like:
58 1 John Freeman
<pre>
59 49 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
60 49 Erik Blaufuss
check failed: '[Errno 111] Connection refused'.  Is lbnecontrol running?
61 1 John Freeman
</pre>
62 1 John Freeman
63 61 John Freeman
To check whether the configuration manager is running, you can simply use Linux commands:
64 61 John Freeman
65 61 John Freeman
<pre>
66 61 John Freeman
ps aux | grep -v grep | grep CfgMgrApp
67 61 John Freeman
</pre>
68 61 John Freeman
69 109 Thomas Dealtry
This will either return info on CfgMgrApp (the actual name of the configuration manager process), or print nothing if it's not running. Similarly, you can check whether the TDU XMLRPC server is running using:
70 71 John Freeman
71 71 John Freeman
<pre>
72 109 Thomas Dealtry
ps aux | grep -v grep | grep tdu
73 1 John Freeman
</pre>
74 1 John Freeman
75 109 Thomas Dealtry
In fact, it's possible to use Linux commands to check the status of all four programs:
76 109 Thomas Dealtry
77 109 Thomas Dealtry
<pre>
78 109 Thomas Dealtry
ps aux | grep -v grep | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp -e tdu
79 109 Thomas Dealtry
</pre>
80 109 Thomas Dealtry
81 110 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.
82 105 John Freeman
83 109 Thomas Dealtry
h3. Cleanup: killing RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
84 105 John Freeman
85 105 John Freeman
To begin using the DAQ, you'll want to kill off any existing RunControl and/or DAQInterface processes. With the process IDs obtained from the command described in the previous section, you can kill any pre-existing such processes. 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. To kill them, again keeping in mind that the second field returned from "ps aux" is the process id (PID), use:
86 105 John Freeman
<pre>
87 105 John Freeman
kill <PID>
88 105 John Freeman
</pre>
89 110 John Freeman
If DAQInterface was in any state other than "stopped" at the time it was killed, it's quite possible that it's left "orphaned" artdaq processes. If this is the case, you'll want to clean these up before trying to run the DAQ again, as they'll block the ports if they remain alive as "zombie" processes. Check the DAQInterface configuration file (defaults to lbnerc/docs/config.txt unless an alternate was supplied via the "-f" option to DAQInterface) to see which node the PMT (Process Management Tool) was running on, and check for it with
90 105 John Freeman
<pre>
91 105 John Freeman
ps aux | grep -v grep | grep pmt.rb
92 105 John Freeman
</pre>
93 105 John Freeman
Use this to get the process ID to kill it. Of course, also be aware that if artdaq processes were in communication with hardware when the orphaning occurred, killing them off might result in issues for the hardware, but the specifics of any hardware issues that may arise go beyond the scope of this document.
94 105 John Freeman
95 1 John Freeman
h3. Starting RunControl
96 49 Erik Blaufuss
97 49 Erik Blaufuss
To start RunControl (after loading environment as above):
98 60 John Freeman
<pre>
99 104 John Freeman
rm -f /tmp/lbnecontrol.pid  # (This should only be necessary if RunControl software wasn't stopped cleanly)
100 49 Erik Blaufuss
lbnecmd launch
101 49 Erik Blaufuss
</pre>
102 1 John Freeman
103 1 John Freeman
h3. Starting DAQInterface
104 1 John Freeman
105 61 John Freeman
To start DAQInterface (after loading environment as above), the basic command is:
106 1 John Freeman
<pre>
107 82 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> &
108 1 John Freeman
</pre>
109 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. 
110 82 John Freeman
111 82 John Freeman
If multiple users with different terminals wish to check the DAQ output, it is recommended to try:
112 1 John Freeman
<pre>
113 82 John Freeman
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> >>~/DI.log 2>&1 &
114 1 John Freeman
</pre>
115 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)
116 82 John Freeman
117 1 John Freeman
h3. Starting the configuration manager
118 1 John Freeman
119 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
120 109 Thomas Dealtry
121 109 Thomas Dealtry
h3. Starting the TDU XMLRPC server
122 109 Thomas Dealtry
123 109 Thomas Dealtry
<pre>
124 109 Thomas Dealtry
tdu -T 192.168.100.201 -P 10001 -H localhost -r 50008
125 109 Thomas Dealtry
</pre>
126 109 Thomas Dealtry
127 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.
128 109 Thomas Dealtry
129 109 Thomas Dealtry
See [[Starting and using TDUControl]] for more details.
130 62 John Freeman
131 61 John Freeman
h1. Configuring and starting Runs
132 1 John Freeman
133 107 John Freeman
Now, you can take the DAQ system through the standard transitions to start a DAQ run.  At all stages, you can use the "lbnecmd check" command to see what state DAQInterface is in; 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:
134 49 Erik Blaufuss
<pre>
135 49 Erik Blaufuss
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
136 1 John Freeman
</pre>
137 108 John Freeman
Note that if a high "debug level" has been set (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:
138 1 John Freeman
139 108 John Freeman
---
140 108 John Freeman
141 117 John Freeman
"stopped" -> _init_ -> "ready" -> _start_ -> "running" -> _pause_ -> "ready" -> _resume_ -> "running" -> _stop_ -> "ready" -> _terminate_ -> "stopped"
142 108 John Freeman
143 108 John Freeman
---
144 1 John Freeman
145 94 John Freeman
h2.  Selecting a run configuration and DAQ components
146 49 Erik Blaufuss
147 1 John Freeman
*Before initializing or starting a DAQ run*, a configuration and set of DAQComponents must be selected.  This is done via RunControl.
148 1 John Freeman
149 49 Erik Blaufuss
h3. List and select a configuration:
150 1 John Freeman
151 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
152 49 Erik Blaufuss
<pre>
153 49 Erik Blaufuss
lbnecmd listconfigs
154 1 John Freeman
</pre>
155 49 Erik Blaufuss
Will return a list of configs:
156 49 Erik Blaufuss
<pre>
157 49 Erik Blaufuss
Available configs (Name : description)
158 1 John Freeman
159 111 John Freeman
8xssp_with_nova_sync : Sorry, no description found.
160 111 John Freeman
6xssp_ext : Sorry, no description found.
161 111 John Freeman
2xssp_ssp01_led_ssp02_tstamp : Sorry, no description found.
162 111 John Freeman
demo : This is a demo.  Testing 1, 2, 3…
163 30 John Freeman
...
164 1 John Freeman
165 49 Erik Blaufuss
Current selected config: No Config
166 49 Erik Blaufuss
</pre>
167 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:
168 49 Erik Blaufuss
<pre> 
169 49 Erik Blaufuss
lbnecmd setconfig demo
170 1 John Freeman
</pre>
171 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.
172 1 John Freeman
173 49 Erik Blaufuss
h3. List and select DAQ components.
174 1 John Freeman
175 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
176 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.
177 38 John Freeman
178 1 John Freeman
To see the list of available DAQ components:
179 49 Erik Blaufuss
<pre>
180 1 John Freeman
lbnecmd listdaqcomps
181 49 Erik Blaufuss
</pre>
182 62 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
183 1 John Freeman
<pre>
184 112 John Freeman
Available:
185 112 John Freeman
component01 (lbnedaq2:5205)
186 112 John Freeman
component02 (lbnedaq2:5206)
187 112 John Freeman
188 112 John Freeman
ssp08 (lbnedaq1:5214)
189 112 John Freeman
190 112 John Freeman
Selected:
191 112 John Freeman
component01 (lbnedaq2:5205)
192 112 John Freeman
component02 (lbnedaq2:5206)
193 112 John Freeman
194 112 John Freeman
ssp08 (lbnedaq1:5214)
195 62 John Freeman
</pre>
196 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:
197 1 John Freeman
<pre>
198 118 John Freeman
lbnecmd setdaqcomps component0{1,2}
199 49 Erik Blaufuss
</pre>
200 118 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 compnents are not known, an error is returned.
201 49 Erik Blaufuss
To change the list of available components, see below.
202 29 John Freeman
203 91 John Freeman
h2. Initializing, starting, stopping and terminating a Run
204 1 John Freeman
205 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:
206 1 John Freeman
<pre>
207 49 Erik Blaufuss
lbnecmd check
208 1 John Freeman
</pre>
209 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.
210 1 John Freeman
211 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:
212 1 John Freeman
<pre>
213 1 John Freeman
lbnecmd init daq
214 1 John Freeman
</pre>
215 1 John Freeman
216 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
217 29 John Freeman
<pre>
218 1 John Freeman
lbnecmd start daq
219 29 John Freeman
</pre>
220 49 Erik Blaufuss
Note: the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command:
221 49 Erik Blaufuss
<pre>
222 49 Erik Blaufuss
lbnecmd check
223 49 Erik Blaufuss
lbnecontrol: running
224 49 Erik Blaufuss
Run number: 207
225 49 Erik Blaufuss
Run configuration: demo
226 1 John Freeman
227 49 Erik Blaufuss
daqint@localhost:5570 (synchronous): running
228 49 Erik Blaufuss
</pre>
229 49 Erik Blaufuss
230 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:
231 22 John Freeman
<pre>
232 21 John Freeman
lbnecmd pause daq
233 42 John Freeman
</pre>
234 41 John Freeman
235 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:
236 48 John Freeman
<pre>
237 48 John Freeman
lbnecmd resume daq
238 48 John Freeman
</pre>
239 48 John Freeman
240 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
241 48 John Freeman
<pre>
242 48 John Freeman
lbnecmd stop daq
243 49 Erik Blaufuss
</pre>
244 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
245 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:
246 1 John Freeman
247 1 John Freeman
<pre>
248 1 John Freeman
lbnecmd terminate daq
249 1 John Freeman
</pre>
250 67 Erik Blaufuss
251 67 Erik Blaufuss
If you want to stop all RunControl processes (known as "lbnecontrol"):
252 67 Erik Blaufuss
<pre>
253 67 Erik Blaufuss
lbnecmd kill
254 67 Erik Blaufuss
</pre>
255 67 Erik Blaufuss
After this, you will need to relaunch RunControl as above.
256 1 John Freeman
257 49 Erik Blaufuss
h2. After your DAQ run.
258 1 John Freeman
259 49 Erik Blaufuss
Once you've completed your run, there are a few things you can look at. 
260 48 John Freeman
261 76 John Freeman
h3. The DAQ log
262 76 John Freeman
263 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/.
264 76 John Freeman
265 76 John Freeman
h3. The run record
266 76 John Freeman
267 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>. 
268 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. 
269 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. 
270 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. 
271 115 John Freeman
272 119 John Freeman
As an example, in /data/lbnedaq/run_records/778 (the directory for run 778), the metadata file looks like the following:
273 72 John Freeman
<pre>
274 72 John Freeman
Config name: demo
275 72 John Freeman
Component #0: component01
276 1 John Freeman
Component #1: component02
277 119 John Freeman
lbne-artdaq commit: 0f0f9be1c63a3b487170579c887ce79944eca6f8
278 119 John Freeman
lbnerc commit: 92935f2702c5e0aa732fd3cc9ff6758e1a0c288c
279 119 John Freeman
/data/lbnedaq/config/ commit: 97d8b222742a41d5d10ea942a063ddfacac3ce93
280 114 John Freeman
281 114 John Freeman
282 119 John Freeman
pmt logfile(s): lbnedaq3:/data/lbnedaq/daqlogs/pmt/pmt-25771*.log
283 114 John Freeman
284 1 John Freeman
boardreader logfiles: 
285 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37365.log
286 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37366.log
287 114 John Freeman
288 114 John Freeman
eventbuilder logfiles: 
289 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37364.log
290 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37363.log
291 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37368.log
292 114 John Freeman
293 114 John Freeman
aggregator logfiles: 
294 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37369.log
295 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37367.log
296 119 John Freeman
297 1 John Freeman
</pre>
298 76 John Freeman
299 81 John Freeman
h3. Output of the Art modules
300 76 John Freeman
301 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.
302 76 John Freeman
303 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:
304 76 John Freeman
305 76 John Freeman
<pre>
306 76 John Freeman
cd <lbne-artdaq basedir>
307 76 John Freeman
source setupLBNEARTDAQ
308 76 John Freeman
rawEventDump -s <rootfile> -n <max events>
309 76 John Freeman
</pre>
310 76 John Freeman
311 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:
312 76 John Freeman
313 76 John Freeman
<pre>
314 81 John Freeman
%MSG-i MF_INIT_OK:  art 01-Dec-2014 16:13:59 CST JobSetup 
315 76 John Freeman
Messagelogger initialization complete.
316 76 John Freeman
%MSG
317 81 John Freeman
%MSG-i PathConfiguration:  art 01-Dec-2014 16:14:00 CST JobSetup 
318 76 John Freeman
Multiple end paths have been combined into one end path,
319 76 John Freeman
"end_path" since order is irrelevant.
320 76 John Freeman
321 76 John Freeman
%MSG
322 81 John Freeman
01-Dec-2014 16:14:00 CST  Initiating request to open file /tmp/lbne35t_r000270_sr01_20141201T221127.root
323 81 John Freeman
01-Dec-2014 16:14:00 CST  Successfully opened file /tmp/lbne35t_r000270_sr01_20141201T221127.root
324 1 John Freeman
--------------------------------------------------------------
325 76 John Freeman
Package             |Version             |Timestamp           
326 81 John Freeman
artdaq-core         |v1_04_06            |01-Dec-2014 21:59:51 UTC
327 81 John Freeman
artdaq              |v1_12_04            |01-Dec-2014 22:01:57 UTC
328 81 John Freeman
lbne-artdaq         |v0_00_08            |01-Dec-2014 22:00:18 UTC
329 81 John Freeman
lbne-artdaq         |v0_07_00            |01-Dec-2014 22:02:57 UTC
330 76 John Freeman
--------------------------------------------------------------
331 81 John Freeman
Begin processing the 1st record. run: 270 subRun: 1 event: 1 at 01-Dec-2014 16:14:00 CST
332 76 John Freeman
PROCESS NAME | MODULE LABEL.. | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE............ | PRODUCT FRIENDLY TYPE | SIZE
333 81 John Freeman
DAQ......... | daq........... | TOY1................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...2
334 1 John Freeman
DAQAG....... | TriggerResults | ..................... | art::TriggerResults.......... | art::TriggerResults.. | ...-
335 76 John Freeman
336 81 John Freeman
Total products (present, not present): 8 (2, 6).
337 76 John Freeman
338 1 John Freeman
PROCESS NAME | MODULE LABEL | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE.................... | PRODUCT FRIENDLY TYPE.... | SIZE
339 76 John Freeman
DAQAG....... | BuildInfo... | LbneArtdaq........... | std::vector<artdaq::PackageBuildInfo> | artdaq::PackageBuildInfos | ...4
340 76 John Freeman
341 76 John Freeman
Total products (present, not present): 1 (1, 0).
342 76 John Freeman
343 81 John Freeman
01-Dec-2014 16:14:00 CST  Closed file /tmp/lbne35t_r000270_sr01_20141201T221127.root
344 76 John Freeman
345 76 John Freeman
TrigReport ---------- Event  Summary ------------
346 76 John Freeman
TrigReport Events total = 1 passed = 1 failed = 0
347 76 John Freeman
348 76 John Freeman
TrigReport ------ Modules in End-Path: end_path ------------
349 76 John Freeman
TrigReport  Trig Bit#    Visited     Passed     Failed      Error Name
350 76 John Freeman
TrigReport     0    0          1          1          0          0 printBuildInfo
351 76 John Freeman
TrigReport     0    0          1          1          0          0 out1
352 76 John Freeman
353 76 John Freeman
TimeReport ---------- Time  Summary ---[sec]----
354 1 John Freeman
TimeReport CPU = 0.003361 Real = 0.003000
355 1 John Freeman
356 76 John Freeman
Art has completed and will exit with status 0.
357 76 John Freeman
</pre>
358 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.
359 81 John Freeman
360 84 John Freeman
h1. Configuring DAQInterface: the DAQInterface configuration file
361 91 John Freeman
362 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:
363 1 John Freeman
<pre>
364 1 John Freeman
365 100 John Freeman
lbne-artdaq: /data/lbnedaq/daqarea/lbne-artdaq-base/build_lbne-artdaq
366 91 John Freeman
367 1 John Freeman
PMT host: lbnedaq3
368 100 John Freeman
PMT port: 5400
369 1 John Freeman
370 49 Erik Blaufuss
pause before initialization: 5
371 49 Erik Blaufuss
372 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
373 49 Erik Blaufuss
debug level: 1
374 49 Erik Blaufuss
375 49 Erik Blaufuss
log directory:   /data/lbnedaq/daqlogs
376 49 Erik Blaufuss
377 91 John Freeman
record directory: /data/lbnedaq/run_records
378 49 Erik Blaufuss
379 116 John Freeman
# If this file is "config.txt" -- i.e., the standard, non-expert,
380 116 John Freeman
# non-testing version of the DAQInterface configuration file -- do not
381 116 John Freeman
# set "disable configuration check" to "true"
382 116 John Freeman
383 101 John Freeman
disable configuration check: false
384 101 John Freeman
385 101 John Freeman
TDU XMLRPC port: 0
386 91 John Freeman
387 91 John Freeman
EventBuilder host: lbnedaq2
388 48 John Freeman
EventBuilder port: 5235
389 91 John Freeman
390 91 John Freeman
EventBuilder host: lbnedaq2
391 91 John Freeman
EventBuilder port: 5236
392 48 John Freeman
393 91 John Freeman
Aggregator host: lbnedaq2
394 91 John Freeman
Aggregator port: 5265
395 48 John Freeman
396 91 John Freeman
Aggregator host: lbnedaq2
397 1 John Freeman
Aggregator port: 5266
398 1 John Freeman
399 1 John Freeman
</pre>
400 1 John Freeman
401 92 John Freeman
The meaning of these parameters is as follows:
402 92 John Freeman
403 92 John Freeman
* *lbne-artdaq* : the directory in which the desired build of lbne-artdaq to use is located
404 92 John Freeman
405 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
406 100 John Freeman
* *PMT port* : pmt.rb's port
407 92 John Freeman
408 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
409 1 John Freeman
410 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. 
411 92 John Freeman
412 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/
413 93 John Freeman
414 93 John Freeman
* *record directory* : the directory to which metadata about the run (FHiCL documents used, DAQInterface configuration file used, etc.) gets sent
415 101 John Freeman
416 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. 
417 101 John Freeman
418 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
419 49 Erik Blaufuss
420 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.
421 49 Erik Blaufuss
422 57 John Freeman
h1. Adding new configurations to RunControl
423 57 John Freeman
424 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. 
425 68 John Freeman
426 91 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are edited within the directory
427 57 John Freeman
<pre>
428 57 John Freeman
/data/lbnedaq/config/<named_configuration>
429 57 John Freeman
</pre>
430 57 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
431 57 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
432 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")
433 59 John Freeman
434 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.
435 59 John Freeman
<pre>
436 1 John Freeman
 event_builder_count: PLACEHOLDER
437 59 John Freeman
</pre>
438 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.
439 1 John Freeman
440 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
441 68 John Freeman
<pre>
442 68 John Freeman
git log
443 68 John Freeman
</pre>
444 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:
445 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:
446 68 John Freeman
<pre>
447 68 John Freeman
# On branch master
448 68 John Freeman
# Changes to be committed:
449 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
450 68 John Freeman
#
451 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
452 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
453 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
454 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
455 68 John Freeman
#
456 68 John Freeman
</pre>
457 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.:
458 68 John Freeman
<pre>
459 1 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
460 68 John Freeman
</pre>
461 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. 
462 68 John Freeman
</pre>
463 68 John Freeman
Now, make sure that the commit took place correctly by running
464 68 John Freeman
<pre>
465 68 John Freeman
git diff HEAD
466 68 John Freeman
</pre>
467 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
468 1 John Freeman
<pre>
469 68 John Freeman
git log
470 68 John Freeman
</pre>
471 69 John Freeman
you should be able to see your commit at the top.
472 57 John Freeman
473 79 John Freeman
* Finally, make sure to push your change to the central repository; to do this, simply execute
474 79 John Freeman
<pre>
475 79 John Freeman
git push origin
476 79 John Freeman
</pre>
477 79 John Freeman
478 79 John Freeman
and now, if you run 
479 79 John Freeman
480 79 John Freeman
<pre>
481 79 John Freeman
git diff origin/master
482 79 John Freeman
</pre>
483 79 John Freeman
484 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. 
485 79 John Freeman
486 56 Erik Blaufuss
h1. Adding new DAQ Components to RunControl
487 49 Erik Blaufuss
488 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
489 49 Erik Blaufuss
<pre>
490 49 Erik Blaufuss
/home/lbnedaq/.lbnerc-components
491 18 John Freeman
</pre>
492 55 Erik Blaufuss
Each entry (name: host port) defines:
493 55 Erik Blaufuss
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
494 49 Erik Blaufuss
* host - hostname where BoardReader process will be started
495 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
496 18 John Freeman
497 49 Erik Blaufuss
For example:
498 49 Erik Blaufuss
<pre>
499 49 Erik Blaufuss
component01: lbnedaq2 5205
500 49 Erik Blaufuss
component02: lbnedaq2 5206
501 49 Erik Blaufuss
</pre>
502 49 Erik Blaufuss
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
503 27 John Freeman
504 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
505 28 John Freeman
506 49 Erik Blaufuss
h2.  Common RunControl issues
507 27 John Freeman
508 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
509 1 John Freeman
510 49 Erik Blaufuss
<pre>
511 49 Erik Blaufuss
lbnecmd help
512 49 Erik Blaufuss
</pre>
513 50 Erik Blaufuss
will list all available commands for RunControl with some details for help.  
514 50 Erik Blaufuss
 
515 1 John Freeman
h3.  No real configurations are listed by RunControl
516 45 John Freeman
517 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
518 45 John Freeman
<pre>
519 49 Erik Blaufuss
Available configs (Name : description)
520 49 Erik Blaufuss
521 49 Erik Blaufuss
dummy : Dummy description
522 45 John Freeman
</pre>
523 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)
524 1 John Freeman
525 49 Erik Blaufuss
h2.  Common DAQInterface issues
526 49 Erik Blaufuss
527 49 Erik Blaufuss
h3.  *Error handling*
528 49 Erik Blaufuss
529 49 Erik Blaufuss
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
530 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
531 49 Erik Blaufuss
# During periodic checks, one or more artdaq processes expected to exist are not found
532 49 Erik Blaufuss
533 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). 
534 49 Erik Blaufuss
535 84 John Freeman
h3. *Your change to the DAQInterface configuration file or the daqinterface.py code doesn't seem to do anything*
536 49 Erik Blaufuss
537 1 John Freeman
Make sure you kill the existing daqinterface process and restart it
538 49 Erik Blaufuss
539 54 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
540 49 Erik Blaufuss
541 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.
542 54 John Freeman
543 49 Erik Blaufuss
h3. *On the initial transition, you see a regularly updating printout saying "Waiting for all processes to be launched"*
544 1 John Freeman
545 1 John Freeman
Seeing one or two of these is fine. If, after several seconds, something like the following
546 1 John Freeman
<pre>
547 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)
548 1 John Freeman
</pre>
549 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 
550 1 John Freeman
<pre>
551 1 John Freeman
ps aux | grep -v grep | grep pmt.rb 
552 51 John Freeman
</pre>
553 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.
554 77 John Freeman
555 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*
556 1 John Freeman
557 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.