Running DAQ Interface » History » Version 54

John Freeman, 11/14/2014 01:45 PM

1 49 Erik Blaufuss
h1. Getting help
2 1 John Freeman
3 49 Erik Blaufuss
If you run into issues, or have questions, please contact:
4 49 Erik Blaufuss
* DAQInterface
5 49 Erik Blaufuss
** John Freeman -
6 49 Erik Blaufuss
* Run Control
7 49 Erik Blaufuss
** Erik Blaufuss -
8 1 John Freeman
9 49 Erik Blaufuss
h1. Starting DAQInterface and Run Control
10 49 Erik Blaufuss
11 49 Erik Blaufuss
DAQInterface is designed to be run, along with rest of the run control code, on, using the lbnedaq account.  These instructions will focus the use of DAQInterface on the gateway node.  If you need access to the account, please contact one of us.
12 49 Erik Blaufuss
The DAQInterface and RunControl software can also be run on the lbnedaqtest01 VM machine, please contact John Freeman at, for more details.
13 49 Erik Blaufuss
14 49 Erik Blaufuss
The installed code is located at /data/lbnedaq/scratch/DAQInterface/lbnerc. To get started, login and first setup the environment:
15 49 Erik Blaufuss
16 30 John Freeman
17 49 Erik Blaufuss
18 33 John Freeman
cd /data/lbnedaq/scratch/DAQInterface
19 1 John Freeman
source fireup
20 1 John Freeman
21 1 John Freeman
22 30 John Freeman
This will take you into the /data/lbnedaq/scratch/DAQInterface/lbnerc directory. It's a good idea to check whether lbnecontrol (the run control application) and/or DAQInterface (the component which intermediates between run control and artdaq processes) are already running; if they are, the instructions below won't work. To check this, you can try:
23 1 John Freeman
24 1 John Freeman
25 49 Erik Blaufuss
lbnecmd check
26 1 John Freeman
27 1 John Freeman
28 49 Erik Blaufuss
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 stopped:
29 49 Erik Blaufuss
30 49 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
31 49 Erik Blaufuss
lbnecontrol: running
32 49 Erik Blaufuss
daqint@localhost:5770 (synchronous): stopped
33 49 Erik Blaufuss
34 1 John Freeman
35 49 Erik Blaufuss
If RunControl is not running, you'll see something like:
36 1 John Freeman
37 49 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
38 49 Erik Blaufuss
check failed: '[Errno 111] Connection refused'.  Is lbnecontrol running?
39 49 Erik Blaufuss
40 1 John Freeman
41 49 Erik Blaufuss
h3. Starting RunControl
42 1 John Freeman
43 49 Erik Blaufuss
To start RunControl (after loading environment as above):
44 49 Erik Blaufuss
45 49 Erik Blaufuss
lbnecmd launch
46 49 Erik Blaufuss
47 1 John Freeman
48 49 Erik Blaufuss
h3. Starting DAQInterface
49 1 John Freeman
50 49 Erik Blaufuss
To start DAQInterface (after loading environment as above):
51 49 Erik Blaufuss
52 49 Erik Blaufuss
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost >>~/DI.log 2>&1 &
53 49 Erik Blaufuss
54 49 Erik Blaufuss
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)
55 49 Erik Blaufuss
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. 
56 1 John Freeman
57 49 Erik Blaufuss
h3. Performing a hard reset of RunControl and DAQInterface
58 1 John Freeman
59 49 Erik Blaufuss
If needed, you can track down the process names and kill them explicitly to get a clean reset:
60 49 Erik Blaufuss
61 49 Erik Blaufuss
ps aux | grep -v grep | grep lbnecontrol
62 49 Erik Blaufuss
ps aux | grep -v grep | grep daqinterface
63 49 Erik Blaufuss
64 49 Erik Blaufuss
If these processes are running, it either means that someone else is using DAQInterface, or that someone else who's done with DAQInterface 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:
65 49 Erik Blaufuss
66 49 Erik Blaufuss
kill <PID>
67 49 Erik Blaufuss
68 1 John Freeman
69 49 Erik Blaufuss
h1. Configuring and starting Runs
70 1 John Freeman
71 49 Erik Blaufuss
All of these steps assume that the CfgMgr process is available.  To start this, please see the documentation here:
72 1 John Freeman
73 49 Erik Blaufuss
Now, you can take DAQ Interface 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 it's log file when transitions are complete:
74 49 Erik Blaufuss
75 49 Erik Blaufuss
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
76 49 Erik Blaufuss
77 49 Erik Blaufuss
Note that if a high "debug level" has been set, 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. 
78 1 John Freeman
79 49 Erik Blaufuss
h2.  Selecting a configuration and DAQcomponents
80 1 John Freeman
81 49 Erik Blaufuss
*Before initializing or starting a DAQ run*, a configuration and set of DAQComponents must be selected.  This is done via RunControl.
82 1 John Freeman
83 49 Erik Blaufuss
h3. List and select a configuration:
84 1 John Freeman
85 49 Erik Blaufuss
To see the list of available configurations (queried from CfgMgr):
86 49 Erik Blaufuss
87 49 Erik Blaufuss
lbnecmd listconfigs
88 1 John Freeman
89 49 Erik Blaufuss
Will return a list of configs:
90 49 Erik Blaufuss
91 49 Erik Blaufuss
Available configs (Name : description)
92 1 John Freeman
93 49 Erik Blaufuss
demo : Pithy description
94 49 Erik Blaufuss
tmp1 : Pithy description
95 49 Erik Blaufuss
96 30 John Freeman
97 49 Erik Blaufuss
Current selected config: No Config
98 49 Erik Blaufuss
99 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:
100 49 Erik Blaufuss
101 49 Erik Blaufuss
lbnecmd setconfig demo
102 49 Erik Blaufuss
103 49 Erik Blaufuss
This will return "OK" if successful (at "listconfigs" will show this as the current config).  If the specified configuration is not known, an error is returned.
104 1 John Freeman
105 49 Erik Blaufuss
h3. List and select DAQ components.
106 1 John Freeman
107 49 Erik Blaufuss
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 Boardreader processes
108 49 Erik Blaufuss
that read them out.   As an operator, you need to ensure that there are configuration files available in CfgMgr for the DAQ Components that you select here,
109 49 Erik Blaufuss
or DAQInterface will return an error.
110 38 John Freeman
111 49 Erik Blaufuss
To see the list of available DAQ components:
112 1 John Freeman
113 49 Erik Blaufuss
lbnecmd listdaqcomps
114 38 John Freeman
115 49 Erik Blaufuss
Will return a list of components available and selected (*Default* is ALL available components):
116 49 Erik Blaufuss
117 49 Erik Blaufuss
{'available': {'component02': ['lbnedaq2', '5206'], 'component01': ['lbnedaq2', '5205']}}
118 49 Erik Blaufuss
{'selected': {'component02': ['lbnedaq2', '5206'], 'component01': ['lbnedaq2', '5205']}}
119 49 Erik Blaufuss
120 49 Erik Blaufuss
Shown are the available components by name, along with the requested host/port to run the BoardReader process on. You can then select a list of DAQ components to use in the run:
121 49 Erik Blaufuss
122 49 Erik Blaufuss
lbnecmd setdaqcomps component01 component02
123 49 Erik Blaufuss
124 49 Erik Blaufuss
This will return "OK" if successful (at "lisdaqcomps" will show this as the current config).  If the specified compnents are not known, an error is returned.
125 49 Erik Blaufuss
To change the list of available components, see below.
126 29 John Freeman
127 49 Erik Blaufuss
h2. Configuring, starting, stopping and terminating a Run
128 1 John Freeman
129 49 Erik Blaufuss
For each of these transitions, please recall that while "lbnecmd <cmd>" returns very quickly, the actual command can take several seconds or minutes to happen.  Before issuing another command, be sure that the transition is complete by using the check command:
130 1 John Freeman
131 49 Erik Blaufuss
lbnecmd check
132 1 John Freeman
133 49 Erik Blaufuss
and ensure that the DAQ is, for example, in the "ready" state and not still in the "initializing" stage.
134 1 John Freeman
135 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:
136 1 John Freeman
137 1 John Freeman
lbnecmd init daq
138 1 John Freeman
139 1 John Freeman
140 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
141 29 John Freeman
142 1 John Freeman
lbnecmd start daq
143 29 John Freeman
144 49 Erik Blaufuss
Note: the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command:
145 49 Erik Blaufuss
146 49 Erik Blaufuss
lbnecmd check
147 49 Erik Blaufuss
lbnecontrol: running
148 49 Erik Blaufuss
Run number: 207
149 49 Erik Blaufuss
Run configuration: demo
150 1 John Freeman
151 49 Erik Blaufuss
daqint@localhost:5570 (synchronous): running
152 49 Erik Blaufuss
153 49 Erik Blaufuss
154 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:
155 22 John Freeman
156 21 John Freeman
lbnecmd pause daq
157 44 John Freeman
158 42 John Freeman
159 49 Erik Blaufuss
Resume the running of the DAQ, putting returning to the "running" state.  This will restart data taking to a new output file:
160 41 John Freeman
161 48 John Freeman
lbnecmd resume daq
162 48 John Freeman
163 48 John Freeman
164 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
165 48 John Freeman
166 48 John Freeman
lbnecmd stop daq
167 48 John Freeman
168 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
169 49 Erik Blaufuss
*NOTE* To select a new configuration or DAQ component set, you must kill all ArtDAQ processes with the "terminate" command:
170 1 John Freeman
171 1 John Freeman
Now, return to the "stopped" state, killing all the artdaq processes:
172 1 John Freeman
173 1 John Freeman
lbnecmd terminate daq
174 1 John Freeman
175 1 John Freeman
176 49 Erik Blaufuss
h2. After your DAQ run.
177 1 John Freeman
178 49 Erik Blaufuss
Once you've completed your run, there are a few things you can look at. 
179 48 John Freeman
180 49 Erik Blaufuss
* A record of the DAQ's output will be saved in the subdirectory pmt/ relative to where you specified the output logfiles; thus in the example config.txt below, you'd find the output in /data/lbnedaq/daqlogs/pmt/. 
181 51 John Freeman
* Also, a record of the FHiCL documents sent to the artdaq processes and the docs/config.txt file 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. 
182 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. 
183 49 Erik Blaufuss
** 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. 
184 52 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.
185 1 John Freeman
186 49 Erik Blaufuss
h1. Configuring DAQInterface
187 49 Erik Blaufuss
188 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). 
189 49 Erik Blaufuss
It should look something like the following:
190 1 John Freeman
191 49 Erik Blaufuss
lbne-artdaq: /data/lbnedaq/scratch/DAQInterface/build_lbne-artdaq
192 1 John Freeman
193 49 Erik Blaufuss
PMT host: lbnedaq3
194 49 Erik Blaufuss
195 49 Erik Blaufuss
pause before initialization: 5
196 49 Erik Blaufuss
197 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
198 49 Erik Blaufuss
debug level: 1
199 49 Erik Blaufuss
200 49 Erik Blaufuss
log directory:   /data/lbnedaq/daqlogs
201 49 Erik Blaufuss
202 49 Erik Blaufuss
record directory: /data/lbnedaq/scratch/jcfree/TemporarySaveArea/
203 49 Erik Blaufuss
204 1 John Freeman
 EventBuilder host: lbnedaq2
205 48 John Freeman
 EventBuilder port: 5235
206 48 John Freeman
 EventBuilder fhicl: /data/lbnedaq/fcl/EventBuilder_demo1.fcl
207 48 John Freeman
208 48 John Freeman
 EventBuilder host: lbnedaq2
209 48 John Freeman
 EventBuilder port: 5236
210 48 John Freeman
 EventBuilder fhicl: /data/lbnedaq/fcl/EventBuilder_demo2.fcl
211 48 John Freeman
212 48 John Freeman
 Aggregator host: lbnedaq2
213 48 John Freeman
 Aggregator port: 5265
214 41 John Freeman
215 1 John Freeman
 Aggregator host: lbnedaq2
216 21 John Freeman
 Aggregator port: 5266
217 49 Erik Blaufuss
218 1 John Freeman
219 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).
220 49 Erik Blaufuss
221 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.
222 49 Erik Blaufuss
223 49 Erik Blaufuss
h1. Adding new DAQComponents to RunControl
224 49 Erik Blaufuss
225 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
226 49 Erik Blaufuss
227 49 Erik Blaufuss
228 18 John Freeman
229 49 Erik Blaufuss
Each entry defines:
230 49 Erik Blaufuss
* Name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
231 49 Erik Blaufuss
* host - hostname where BoardReader process will be started
232 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
233 18 John Freeman
234 49 Erik Blaufuss
For example:
235 49 Erik Blaufuss
236 49 Erik Blaufuss
component01: lbnedaq2 5205
237 49 Erik Blaufuss
component02: lbnedaq2 5206
238 49 Erik Blaufuss
239 49 Erik Blaufuss
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
240 27 John Freeman
241 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
242 28 John Freeman
243 49 Erik Blaufuss
h2.  Common RunControl issues
244 27 John Freeman
245 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
246 1 John Freeman
247 49 Erik Blaufuss
248 49 Erik Blaufuss
lbnecmd help
249 49 Erik Blaufuss
250 50 Erik Blaufuss
will list all available commands for RunControl with some details for help.  
251 50 Erik Blaufuss
252 50 Erik Blaufuss
h3.  No real configurations are listed by RunControl
253 45 John Freeman
254 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
255 45 John Freeman
256 49 Erik Blaufuss
Available configs (Name : description)
257 49 Erik Blaufuss
258 49 Erik Blaufuss
dummy : Dummy description
259 45 John Freeman
260 49 Erik Blaufuss
Instead of your expected configurations, RunControl is not able to connect to CfgMgr.  Please make sure it's running (
261 1 John Freeman
262 49 Erik Blaufuss
h2.  Common DAQInterface issues
263 49 Erik Blaufuss
264 49 Erik Blaufuss
h3.  *Error handling*
265 49 Erik Blaufuss
266 49 Erik Blaufuss
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
267 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
268 49 Erik Blaufuss
# During periodic checks, one or more artdaq processes expected to exist are not found
269 49 Erik Blaufuss
270 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). 
271 49 Erik Blaufuss
272 49 Erik Blaufuss
h3. *Your change to docs/config.txt or doesn't seem to do anything*
273 49 Erik Blaufuss
274 1 John Freeman
Make sure you kill the existing daqinterface process and restart it
275 49 Erik Blaufuss
276 54 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
277 49 Erik Blaufuss
278 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.
279 54 John Freeman
280 49 Erik Blaufuss
h3. *On the initial transition, you see a regularly updating printout saying "Waiting for all processes to be launched"*
281 49 Erik Blaufuss
282 1 John Freeman
Seeing one or two of these is fine. If, after several seconds, something like the following
283 1 John Freeman
284 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)
285 1 John Freeman
286 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 
287 1 John Freeman
288 1 John Freeman
ps aux | grep -v grep | grep pmt.rb 
289 1 John Freeman
290 51 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.