Project

General

Profile

Running DAQ Interface » History » Version 153

John Freeman, 03/30/2015 02:47 PM

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