Running DAQ Interface » History » Version 80

John Freeman, 12/01/2014 01:23 PM

1 58 John Freeman
2 58 John Freeman
3 49 Erik Blaufuss
h1. Getting help
4 1 John Freeman
5 78 John Freeman
If, after reading this document (in particular, the "Troubleshooting and FAQ" section) you run into issues, or have questions, please contact:
6 49 Erik Blaufuss
* DAQInterface
7 49 Erik Blaufuss
** John Freeman -
8 62 John Freeman
* RunControl
9 49 Erik Blaufuss
** Erik Blaufuss -
10 66 John Freeman
* Configuration Manager
11 66 John Freeman
** Jon Paley -
12 1 John Freeman
13 1 John Freeman
h1. Starting DAQInterface and Run Control
14 1 John Freeman
15 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, using the lbnedaq account. If you need access to the account, please contact one of us.
16 66 John Freeman
Primarily of developer (as opposed to user) interest, DAQInterface and RunControl software can also be run on the lbnedaqtest01 VM machine, please contact John Freeman at, for more details.
17 49 Erik Blaufuss
18 66 John Freeman
The installed code is located at To get started, login and first setup the environment:
19 49 Erik Blaufuss
20 30 John Freeman
21 33 John Freeman
22 1 John Freeman
cd /data/lbnedaq/scratch/DAQInterface
23 1 John Freeman
source fireup
24 1 John Freeman
25 1 John Freeman
26 66 John Freeman
This will take you into the /data/lbnedaq/scratch/DAQInterface/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 aren't, 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:
27 1 John Freeman
28 1 John Freeman
29 49 Erik Blaufuss
lbnecmd check
30 1 John Freeman
31 1 John Freeman
32 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:
33 49 Erik Blaufuss
34 49 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
35 49 Erik Blaufuss
lbnecontrol: running
36 49 Erik Blaufuss
daqint@localhost:5770 (synchronous): stopped
37 49 Erik Blaufuss
38 1 John Freeman
39 73 John Freeman
If RunControl is running, and at some point DAQInterface was running but has since been killed:
40 73 John Freeman
41 73 John Freeman
lbnecontrol: running
42 73 John Freeman
daqint@localhost:5770 (synchronous): missing
43 73 John Freeman
44 73 John Freeman
(In this case, just restart DAQInterface).
45 73 John Freeman
46 49 Erik Blaufuss
If RunControl is not running, you'll see something like:
47 1 John Freeman
48 49 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
49 49 Erik Blaufuss
check failed: '[Errno 111] Connection refused'.  Is lbnecontrol running?
50 1 John Freeman
51 1 John Freeman
52 61 John Freeman
To check whether the configuration manager is running, you can simply use Linux commands:
53 61 John Freeman
54 61 John Freeman
55 61 John Freeman
ps aux | grep -v grep | grep CfgMgrApp
56 61 John Freeman
57 61 John Freeman
58 71 John Freeman
This will either return info on the CfgMgrApp process, or print nothing if it's not running. In fact, it's possible to use Linux commands to check the status of all three programs:
59 71 John Freeman
60 71 John Freeman
61 75 John Freeman
ps aux | grep -v grep | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp
62 71 John Freeman
63 61 John Freeman
64 1 John Freeman
h3. Starting RunControl
65 49 Erik Blaufuss
66 49 Erik Blaufuss
To start RunControl (after loading environment as above):
67 60 John Freeman
68 70 John Freeman
rm /tmp/  # (This should only be necessary of RunControl software wasn't stopped cleanly)
69 49 Erik Blaufuss
lbnecmd launch
70 49 Erik Blaufuss
71 1 John Freeman
72 1 John Freeman
h3. Starting DAQInterface
73 1 John Freeman
74 61 John Freeman
To start DAQInterface (after loading environment as above), the basic command is:
75 1 John Freeman
76 61 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost &
77 61 John Freeman
78 61 John Freeman
However, particularly if multiple users with different terminals wish to check the DAQ output, it is recommended to try:
79 61 John Freeman
80 49 Erik Blaufuss
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost >>~/DI.log 2>&1 &
81 1 John Freeman
82 1 John Freeman
This will launch daqinterface in the background, with all messages being collected (appended to the bottom of...) in the file ~/DI.log  (The stdbuf -oL prevents and buffering of output to the file)
83 63 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.
84 1 John Freeman
85 1 John Freeman
h3. Starting the configuration manager
86 63 John Freeman
87 62 John Freeman
Please see Jon Paley's documentation here:
88 62 John Freeman
89 61 John Freeman
h3. Forcing cleanup: performing a hard reset of RunControl, DAQInterface and the configuration manager
90 49 Erik Blaufuss
91 80 John Freeman
If needed, you can track down the process names and kill them explicitly to get a clean reset, using the same bash command shown above to get process info:
92 49 Erik Blaufuss
93 80 John Freeman
ps aux | grep -v grep | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp
94 49 Erik Blaufuss
95 61 John Freeman
If these processes are running, it either means 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, the second field returned from "ps aux" is the process id (PID), use:
96 1 John Freeman
97 49 Erik Blaufuss
kill <PID>
98 1 John Freeman
99 74 John Freeman
If daqinterface is killed externally, then if it was in any state other than "stopped" at the time (and it likely was, otherwise a hard reset would likely have been avoidable), 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 config.txt file to see which node the PMT (Process Management Tool) was running on, and check for it with
100 74 John Freeman
101 74 John Freeman
ps aux | grep -v grep | grep pmt.rb
102 74 John Freeman
103 75 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.
104 1 John Freeman
105 61 John Freeman
h1. Configuring and starting Runs
106 1 John Freeman
107 61 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 to its log file when transitions are complete:
108 49 Erik Blaufuss
109 49 Erik Blaufuss
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
110 61 John Freeman
111 1 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. 
112 1 John Freeman
113 62 John Freeman
h2.  Selecting a configuration and DAQ components
114 49 Erik Blaufuss
115 1 John Freeman
*Before initializing or starting a DAQ run*, a configuration and set of DAQComponents must be selected.  This is done via RunControl.
116 1 John Freeman
117 49 Erik Blaufuss
h3. List and select a configuration:
118 1 John Freeman
119 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
120 49 Erik Blaufuss
121 49 Erik Blaufuss
lbnecmd listconfigs
122 1 John Freeman
123 49 Erik Blaufuss
Will return a list of configs:
124 49 Erik Blaufuss
125 49 Erik Blaufuss
Available configs (Name : description)
126 1 John Freeman
127 49 Erik Blaufuss
demo : Pithy description
128 49 Erik Blaufuss
tmp1 : Pithy description
129 49 Erik Blaufuss
130 30 John Freeman
131 49 Erik Blaufuss
Current selected config: No Config
132 49 Erik Blaufuss
133 49 Erik Blaufuss
This lists all available configs, as well as the current selected config (Note, default config is "No Config").  You can then select a configuration:
134 49 Erik Blaufuss
135 49 Erik Blaufuss
lbnecmd setconfig demo
136 1 John Freeman
137 64 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.
138 1 John Freeman
139 49 Erik Blaufuss
h3. List and select DAQ components.
140 1 John Freeman
141 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
142 62 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,
143 1 John Freeman
or DAQInterface will return an error.
144 38 John Freeman
145 1 John Freeman
To see the list of available DAQ components:
146 49 Erik Blaufuss
147 1 John Freeman
lbnecmd listdaqcomps
148 49 Erik Blaufuss
149 62 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
150 1 John Freeman
151 49 Erik Blaufuss
{'available': {'component02': ['lbnedaq2', '5206'], 'component01': ['lbnedaq2', '5205']}}
152 49 Erik Blaufuss
{'selected': {'component02': ['lbnedaq2', '5206'], 'component01': ['lbnedaq2', '5205']}}
153 49 Erik Blaufuss
154 62 John Freeman
Shown are the available components 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:
155 49 Erik Blaufuss
156 49 Erik Blaufuss
lbnecmd setdaqcomps component01 component02
157 49 Erik Blaufuss
158 62 John Freeman
This will return "OK" if successful ("lbnecmd listdaqcomps" will show this in the "selected" row of components).  If the specified compnents are not known, an error is returned.
159 49 Erik Blaufuss
To change the list of available components, see below.
160 29 John Freeman
161 49 Erik Blaufuss
h2. Configuring, starting, stopping and terminating a Run
162 1 John Freeman
163 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:
164 1 John Freeman
165 49 Erik Blaufuss
lbnecmd check
166 1 John Freeman
167 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.
168 1 John Freeman
169 49 Erik Blaufuss
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 configuration:
170 1 John Freeman
171 1 John Freeman
lbnecmd init daq
172 1 John Freeman
173 1 John Freeman
174 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
175 29 John Freeman
176 1 John Freeman
lbnecmd start daq
177 29 John Freeman
178 49 Erik Blaufuss
Note: the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command:
179 49 Erik Blaufuss
180 49 Erik Blaufuss
lbnecmd check
181 49 Erik Blaufuss
lbnecontrol: running
182 49 Erik Blaufuss
Run number: 207
183 49 Erik Blaufuss
Run configuration: demo
184 1 John Freeman
185 49 Erik Blaufuss
daqint@localhost:5570 (synchronous): running
186 49 Erik Blaufuss
187 49 Erik Blaufuss
188 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:
189 22 John Freeman
190 21 John Freeman
lbnecmd pause daq
191 42 John Freeman
192 41 John Freeman
193 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:
194 48 John Freeman
195 48 John Freeman
lbnecmd resume daq
196 48 John Freeman
197 48 John Freeman
198 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
199 48 John Freeman
200 48 John Freeman
lbnecmd stop daq
201 49 Erik Blaufuss
202 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
203 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:
204 1 John Freeman
205 1 John Freeman
206 1 John Freeman
lbnecmd terminate daq
207 1 John Freeman
208 67 Erik Blaufuss
209 67 Erik Blaufuss
If you want to stop all RunControl processes (known as "lbnecontrol"):
210 67 Erik Blaufuss
211 67 Erik Blaufuss
lbnecmd kill
212 67 Erik Blaufuss
213 67 Erik Blaufuss
After this, you will need to relaunch RunControl as above.
214 1 John Freeman
215 49 Erik Blaufuss
h2. After your DAQ run.
216 1 John Freeman
217 49 Erik Blaufuss
Once you've completed your run, there are a few things you can look at. 
218 48 John Freeman
219 76 John Freeman
h3. The DAQ log
220 76 John Freeman
221 76 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 config.txt below, you'd find the output in /data/lbnedaq/daqlogs/pmt/. 
222 76 John Freeman
223 76 John Freeman
h3. The run record
224 76 John Freeman
225 76 John Freeman
Also, a record of the FHiCL documents sent to the artdaq processes, the config.txt file used to control DAQInterface, and some further information will have been saved; as of this writing (11/12/14) the directory in which this can be found defaults to /data/lbnedaq/scratch/jcfree/TemporarySaveArea/<run number>, although as you might imagine the plan is to eventually change this directory. 
226 51 John Freeman
** PLEASE NOTE that there may be slight differences between the saved FHiCL documents and the FHiCL documents specified in config.txt and/or provided by the choice of configuration. The saved FHiCL document name is standardized to <processtype>_<host>_<port>_r<run number>.fcl, so, e.g, "Aggregator_lbnedaq2_5266_r192.fcl" would be the saved name of /data/lbnedaq/fcl/Aggregator_lbnedaq2_2.fcl, listed in the example config.txt file above, assuming datataking was performed in run 192. 
227 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. 
228 72 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. E.g.,
229 72 John Freeman
230 72 John Freeman
Config name: demo
231 72 John Freeman
Component #0: component01
232 72 John Freeman
Component #1: component02
233 72 John Freeman
lbne-artdaq commit: 13b523181a6f8ff6e78ede590d6372ed6193c79c
234 1 John Freeman
lbnerc commit: 288001cf015e1a763dbba482923fc7ac8f379ae6
235 1 John Freeman
/data/lbnedaq/config commit: 877e43fe3ad96991adf5d57dbfbdefb6300fde25
236 1 John Freeman
237 76 John Freeman
238 76 John Freeman
h3. The Art output
239 76 John Freeman
240 76 John Freeman
Output of the Art modules. 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.
241 76 John Freeman
242 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:
243 76 John Freeman
244 76 John Freeman
245 76 John Freeman
cd <lbne-artdaq basedir>
246 76 John Freeman
source setupLBNEARTDAQ
247 76 John Freeman
rawEventDump -s <rootfile> -n <max events>
248 76 John Freeman
249 76 John Freeman
250 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:
251 76 John Freeman
252 76 John Freeman
253 76 John Freeman
%MSG-i MF_INIT_OK:  art 25-Nov-2014 14:04:55 CST JobSetup 
254 76 John Freeman
Messagelogger initialization complete.
255 76 John Freeman
256 76 John Freeman
%MSG-i PathConfiguration:  art 25-Nov-2014 14:04:55 CST JobSetup 
257 76 John Freeman
Multiple end paths have been combined into one end path,
258 76 John Freeman
"end_path" since order is irrelevant.
259 76 John Freeman
260 76 John Freeman
261 76 John Freeman
25-Nov-2014 14:04:55 CST  Initiating request to open file /tmp/lbne35t_r000264_sr01_20141125T193332.root
262 76 John Freeman
25-Nov-2014 14:04:56 CST  Successfully opened file /tmp/lbne35t_r000264_sr01_20141125T193332.root
263 76 John Freeman
264 76 John Freeman
Package             |Version             |Timestamp           
265 76 John Freeman
artdaq-core         |v1_04_06            |25-Nov-2014 19:27:44 UTC
266 76 John Freeman
artdaq              |v1_12_04            |25-Nov-2014 19:29:42 UTC
267 76 John Freeman
lbne-artdaq         |v0_00_07            |25-Nov-2014 19:28:11 UTC
268 76 John Freeman
lbne-artdaq         |v0_06_00            |25-Nov-2014 19:30:43 UTC
269 76 John Freeman
270 76 John Freeman
Begin processing the 1st record. run: 264 subRun: 1 event: 1 at 25-Nov-2014 14:04:56 CST
271 76 John Freeman
272 76 John Freeman
DAQ......... | daq........... | TOY1................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...1
273 76 John Freeman
DAQ......... | daq........... | PHOTON............... | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...?
274 76 John Freeman
DAQ......... | daq........... | TPC.................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...?
275 76 John Freeman
DAQ......... | daq........... | missed............... | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...?
276 76 John Freeman
DAQ......... | daq........... | unidentified......... | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...?
277 76 John Freeman
DAQ......... | daq........... | TOY2................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...1
278 76 John Freeman
DAQ......... | daq........... | TRIGGER.............. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...?
279 76 John Freeman
DAQAG....... | TriggerResults | ..................... | art::TriggerResults.......... | art::TriggerResults.. | ...-
280 76 John Freeman
281 76 John Freeman
Total products (present, not present): 8 (3, 5).
282 76 John Freeman
283 76 John Freeman
284 76 John Freeman
DAQAG....... | BuildInfo... | LbneArtdaq........... | std::vector<artdaq::PackageBuildInfo> | artdaq::PackageBuildInfos | ...4
285 76 John Freeman
286 76 John Freeman
Total products (present, not present): 1 (1, 0).
287 76 John Freeman
288 76 John Freeman
25-Nov-2014 14:04:56 CST  Closed file /tmp/lbne35t_r000264_sr01_20141125T193332.root
289 76 John Freeman
290 76 John Freeman
TrigReport ---------- Event  Summary ------------
291 76 John Freeman
TrigReport Events total = 1 passed = 1 failed = 0
292 76 John Freeman
293 76 John Freeman
TrigReport ------ Modules in End-Path: end_path ------------
294 76 John Freeman
TrigReport  Trig Bit#    Visited     Passed     Failed      Error Name
295 76 John Freeman
TrigReport     0    0          1          1          0          0 printBuildInfo
296 76 John Freeman
TrigReport     0    0          1          1          0          0 out1
297 76 John Freeman
298 76 John Freeman
TimeReport ---------- Time  Summary ---[sec]----
299 76 John Freeman
TimeReport CPU = 0.003590 Real = 0.002999
300 76 John Freeman
301 76 John Freeman
Art has completed and will exit with status 0.
302 76 John Freeman
303 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, some of which are shown to be available (in this case, TOY1 and TOY2, simulated fragments from 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. 
304 76 John Freeman
305 1 John Freeman
306 49 Erik Blaufuss
h1. Configuring DAQInterface
307 49 Erik Blaufuss
308 52 John Freeman
DAQInterface has some key information stored in a local configuration file (location and ports for EventBuilders, Aggregators, location of artDAQ, log level, etc). These can be changed while DAQInterface is not running,  It's expected that for normal operations, these should not need to changed too often. Assuming the processes aren't running, before getting started, take a look at the configuration file, found in docs/config.txt (relative to /data/lbnedaq/scratch/DAQInterface/lbnerc). 
309 49 Erik Blaufuss
It should look something like the following:
310 1 John Freeman
311 49 Erik Blaufuss
lbne-artdaq: /data/lbnedaq/scratch/DAQInterface/build_lbne-artdaq
312 1 John Freeman
313 49 Erik Blaufuss
PMT host: lbnedaq3
314 49 Erik Blaufuss
315 49 Erik Blaufuss
pause before initialization: 5
316 49 Erik Blaufuss
317 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
318 49 Erik Blaufuss
debug level: 1
319 49 Erik Blaufuss
320 49 Erik Blaufuss
log directory:   /data/lbnedaq/daqlogs
321 49 Erik Blaufuss
322 49 Erik Blaufuss
record directory: /data/lbnedaq/scratch/jcfree/TemporarySaveArea/
323 49 Erik Blaufuss
324 1 John Freeman
 EventBuilder host: lbnedaq2
325 48 John Freeman
 EventBuilder port: 5235
326 48 John Freeman
 EventBuilder fhicl: /data/lbnedaq/fcl/EventBuilder_demo1.fcl
327 48 John Freeman
328 48 John Freeman
 EventBuilder host: lbnedaq2
329 48 John Freeman
 EventBuilder port: 5236
330 48 John Freeman
 EventBuilder fhicl: /data/lbnedaq/fcl/EventBuilder_demo2.fcl
331 48 John Freeman
332 48 John Freeman
 Aggregator host: lbnedaq2
333 48 John Freeman
 Aggregator port: 5265
334 41 John Freeman
335 1 John Freeman
 Aggregator host: lbnedaq2
336 21 John Freeman
 Aggregator port: 5266
337 49 Erik Blaufuss
338 1 John Freeman
339 49 Erik Blaufuss
The "lbne-artdaq" parameter allows the user to set the directory in which the desired build of lbne-artdaq to use is located, the "PMT host" parameter is the host on which artdaq's process management tool script (pmt.rb, used by DAQInterface to launch and kill the artdaq processes) will run, and "log directory" is the directory to which lbne-artdaq's output will be sent. The "debug level" parameter 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. The "pause before initialization" parameter allows the user to set a pause, in seconds, between when the artdaq processes start and when they're initialized; it has been observed that a latency of a few seconds is needed for initialization to proceed correctly (though this is not always the case -- on lbne35t-gateway01, with a high setting for "debug level", a pause is not needed; the reason why "debug level" matters in this context is not yet understood).
340 49 Erik Blaufuss
341 53 John Freeman
After these individual parameters, one defines the EventBuilderMain and AggregatorMain artdaq processes. Specifically, an EventBuilderMain is defined in three lines, where each line should contain "EventBuilder", and define the host and port on which the EventBuilderMain will run (to run an artdaq process on the same host as you're on, use "localhost") as well as the FHiCL document used to initialize the EventBuilderMain. AggregatorMain is defined similarly, using the token "Aggregator", but without the FHiCL document supplied, as this is supplied by the choice of configuration in the configuration manager. Best practice is to place the EventBuilderMain's FHiCL documents in the /data/lbnedaq/fcl directory. 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.
342 49 Erik Blaufuss
343 57 John Freeman
h1. Adding new configurations to RunControl
344 57 John Freeman
345 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. 
346 68 John Freeman
347 68 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are stored within the directory
348 57 John Freeman
349 57 John Freeman
350 57 John Freeman
351 57 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
352 57 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
353 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")
354 59 John Freeman
355 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.
356 59 John Freeman
357 1 John Freeman
 event_builder_count: PLACEHOLDER
358 59 John Freeman
359 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.
360 1 John Freeman
361 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
362 68 John Freeman
363 68 John Freeman
git log
364 68 John Freeman
365 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:
366 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:
367 68 John Freeman
368 68 John Freeman
# On branch master
369 68 John Freeman
# Changes to be committed:
370 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
371 68 John Freeman
372 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
373 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
374 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
375 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
376 68 John Freeman
377 68 John Freeman
378 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.:
379 68 John Freeman
380 68 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
381 68 John Freeman
382 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. 
383 68 John Freeman
384 68 John Freeman
Now, make sure that the commit took place correctly by running
385 68 John Freeman
386 68 John Freeman
git diff HEAD
387 68 John Freeman
388 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
389 1 John Freeman
390 68 John Freeman
git log
391 68 John Freeman
392 69 John Freeman
you should be able to see your commit at the top.
393 57 John Freeman
394 79 John Freeman
* Finally, make sure to push your change to the central repository; to do this, simply execute
395 79 John Freeman
396 79 John Freeman
git push origin
397 79 John Freeman
398 79 John Freeman
399 79 John Freeman
and now, if you run 
400 79 John Freeman
401 79 John Freeman
402 79 John Freeman
git diff origin/master
403 79 John Freeman
404 79 John Freeman
405 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. 
406 79 John Freeman
407 56 Erik Blaufuss
h1. Adding new DAQ Components to RunControl
408 49 Erik Blaufuss
409 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
410 49 Erik Blaufuss
411 49 Erik Blaufuss
412 18 John Freeman
413 55 Erik Blaufuss
Each entry (name: host port) defines:
414 55 Erik Blaufuss
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
415 49 Erik Blaufuss
* host - hostname where BoardReader process will be started
416 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
417 18 John Freeman
418 49 Erik Blaufuss
For example:
419 49 Erik Blaufuss
420 49 Erik Blaufuss
component01: lbnedaq2 5205
421 49 Erik Blaufuss
component02: lbnedaq2 5206
422 49 Erik Blaufuss
423 49 Erik Blaufuss
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
424 27 John Freeman
425 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
426 28 John Freeman
427 49 Erik Blaufuss
h2.  Common RunControl issues
428 27 John Freeman
429 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
430 1 John Freeman
431 49 Erik Blaufuss
432 49 Erik Blaufuss
lbnecmd help
433 49 Erik Blaufuss
434 50 Erik Blaufuss
will list all available commands for RunControl with some details for help.  
435 50 Erik Blaufuss
436 50 Erik Blaufuss
h3.  No real configurations are listed by RunControl
437 45 John Freeman
438 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
439 45 John Freeman
440 49 Erik Blaufuss
Available configs (Name : description)
441 49 Erik Blaufuss
442 49 Erik Blaufuss
dummy : Dummy description
443 45 John Freeman
444 49 Erik Blaufuss
Instead of your expected configurations, RunControl is not able to connect to CfgMgr.  Please make sure it's running (
445 1 John Freeman
446 49 Erik Blaufuss
h2.  Common DAQInterface issues
447 49 Erik Blaufuss
448 49 Erik Blaufuss
h3.  *Error handling*
449 49 Erik Blaufuss
450 49 Erik Blaufuss
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
451 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
452 49 Erik Blaufuss
# During periodic checks, one or more artdaq processes expected to exist are not found
453 49 Erik Blaufuss
454 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). 
455 49 Erik Blaufuss
456 49 Erik Blaufuss
h3. *Your change to docs/config.txt or doesn't seem to do anything*
457 49 Erik Blaufuss
458 1 John Freeman
Make sure you kill the existing daqinterface process and restart it
459 49 Erik Blaufuss
460 54 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
461 49 Erik Blaufuss
462 1 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 docs/config.txt file. Empirically, it appears there needs to be a pause of at least 4 seconds on 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.
463 54 John Freeman
464 49 Erik Blaufuss
h3. *On the initial transition, you see a regularly updating printout saying "Waiting for all processes to be launched"*
465 1 John Freeman
466 1 John Freeman
Seeing one or two of these is fine. If, after several seconds, something like the following
467 1 John Freeman
468 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)
469 1 John Freeman
470 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 
471 1 John Freeman
472 1 John Freeman
ps aux | grep -v grep | grep pmt.rb 
473 51 John Freeman
474 77 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 docs/config.txt?), then try increasing the debug level in docs/config.txt for your next run-through, as this will likely shed light on the nature of the problem.
475 77 John Freeman
476 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*
477 1 John Freeman
478 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.