Running DAQ Interface » History » Version 96

John Freeman, 12/09/2014 02:36 PM

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