S800 Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== S800 Software tools ======

  * [[#Running the S800 DAQ]]
    * [[#Readout GUI]]
    * [[#Mesytec CFD GUI]]
    * [[#Delay Window]]
    * [[#Trigger GUI]]
    * [[#Scaler Display]]
    * [[#Running in Slave mode with multilogger]]
  * [[#Troubleshooting]]





===== Running the S800 DAQ =====
This page gives user-level instructions on how to run the S800 data acquisition (DAQ) system for an experiment. Presently this is run from the linux machine [[Software#u6pc5 (data U6)|u6pc5]] in data-U6. 


==== Readout GUI ====
The S800 Readout GUI is invoked by either clicking the icon **S800 DAQ** in the desktop of [[Software#u6pc5 (data U6)|u6pc5]] or by navigating in a Linux terminal to the directory **/user/s800/converged_daq** and typing ''godaq''. The Readout GUI window will appear with three tags labeled "main", "SSHPipe@localhost:0", and "SSHPipe@localhost:1". The first one provides general information about the ReadoutGUI. The second and third tabs provide information about the data sources (from the CCUSB and VMUSB controllers). **IMPORTANT NOTE:** When running Readout GUI, make sure that the environment variables needed by the system are properly defined. This can be done from a Linux session connected to spdaq19 by typing: ''. /usr/opt/nscldaq/xxxx/daqsetup.bash'', where ''xxxx'' is the nscldaq version (xxx = 11.0-020, on Feb 2016).

Before beginning taking data is necessary to initialize the system. This is done by clicking ''Start'' in the ReadoutGUI. You can inspect the status of each source during their initialization by clicking in one of the tabs "SSHPipe@localhost:0" or "SSHPipe@localhost:1". You will see a series of messages about the different initialization steps. The last message should be "Done". During the initialization process, a fourth tab labeled "ActionFilter" may appear with information from the S800 filter. Sometimes, you may see a warning message about an old "still-running" S800 filter session being killed. That's ok.


After initializing the contollers, the ReadoutGUI window will show the ''Begin'' button active. In addition, three additional buttons should appear at the end of the window. They can be used to start the GUI associated with the [[#Mesytec CFD GUI|MCFD]], [[#Delay Window|Delay XLM]], and [[#Trigger GUI|Trigger ULM]] modules. Make sure that the system is completely initializing before opening those GUIs.

The figure below shows the Readout GUI window after initializing the system. After clicking ''Begin'', the "Event Builder" window will pop out, displaying information about the Readout session. (Note that the tab "ActionFilter" may appear if it didn't show up before, when you clicked ''Start''.) Data can be recorded on disk by checking out the box ''Record''. To end a data run, simply click ''End''. 



{{:wiki:readoutgui2.png|Readout GUI Window}}




==== Mesytec CFD GUI ====
The S800 electronics includes a Mesytec CFD (MCFD), used to "filter" the detector signals going to the Scaler and Mesytec TDC. The configuration parameters of the CFD (thresholds, delays, fraction, etc.) can be remotely adjusted via a MCFD GUI developed by the NSCL DAQ group. During tuning of the S800, one typically needs to adjust thresholds only.

The MCFD GUI can be started in three different ways: 1) by clicking the button ''Launch MCFD GUI'' in [[#Readout GUI|Readout GUI]]; 2) by clicking the icon **MCFD GUI** in the desktop of [[Software#u6pc5 (data U6)|u6pc5]]; 3) by navigating in a Linux terminal and typing ''$DAQBIN/MCFDControl16 --protocol usb --serialfile /dev/ttyUSB0''. The environment variable DAQBIN is defined by sourcing the **daqsetup.bash** file in directory **/usr/opt/nscldaq/xxxx/bin**, where xxxx is the nscldaq version number (11.0-015 on Oct 26, 2015).


{{:wiki:mcfdgui.png|MCFD GUI}}


  * To load the default CFD configuration go to **Load Setting**, select file **MCFD16.tcl** in directory **/user/operations/daq/usb/Config**, and click **Load**
   * Alternatively, it is possible to load the configuration directly from the module by clicking **Update from Device**. 
   * By default, the CFD parameters can be adjusted individually for each of the 16 channels. It is also possible use the module in a "common" mode to set the same CFD parameters to all channels. Just check **common**
  * After modifying any of the CFD parameters, click **Commit to Device**
  * Don't forget to save the new settings in file **MCF16.tcl**. 
     - Go to ''File''
     - Click ''Browse'' and select directory **/user/operations/daq/usb/Config** (default)
     - Select file **MCFD16tcl** and click ''Save''
     - A warning window will pop out to verify that you want to overwrite the existing file. Answer ''Yes''
     - Click again ''Save''
     - Click ''Back'' to return to the main GUI
  * The MCFD module includes the possibility to send a periodic pulsing signal to all the channels. Two frequencies can be selected: 1.22 KHz, and 2.5 MHz 

 

==== Delay Window ====
{{:wiki:delay-window.png|Delay GUI}}





This window appears when the "Launch Gate Delay GUI" button is pressed on the [[#Readout GUI|Readout GUI]]. The delay module allows software configurable delays to be applied to each of the signals indicated in the Channel column, which then form the TDC stops. It is configurable to enable delays to be set with beam on target, as the needed delay may change depending on experimental conditions. 

Some important things to remember:

  * There are four "Delay Inspect" channels (routed to the patch panel in data U6) which can be selected using the Delay GUI  
  * These "Delay Inspect" signals can be compared with any one of the four "Trigger Inspect" channels in order to set proper delays for the TDCs. The "Trigger Inspect" channels can be selected using the [[S800 DAQ tools#Trigger GUI|ULM trigger GUI]]
  * TDCs of last 4 listed signals (including XF and object scintillators) are bypassed with cable delays and thus their delays cannot be controlled with the GUI. They can be inspected, however using the GUI
  * It is possible to bypass the delay of a given channel by checking the "bypass" check box in the GUI
  * The TDC delays can only be changed when the run control is stopped; must SAVE settings before starting run control not to overwrite adjustments being made
  * The S800 trigger used as reference to calculate the ToF is from E1 up signal
  * The signal delays controlled by the GUI (and not by cable delays) are not “pipelined” -- i.e., any new signals that arrive during the delay time of a previous signal are lost and thus deadtime is introduced into the system.  The signals delayed passively by cables are “pipelined” and thus are not subject to deadtime losses



==== Trigger GUI ====

{{:wiki:800px-TriggerGUI.png?800|right|Trigger GUI}}

The Trigger GUI appears when the "Launch ULM GUI" button is pressed on [[#Readout GUI]]. The Trigger GUI is a visual display of the various Gate and Delay Generators and logic elements that make up the configurable trigger of the S800. The logic of the trigger decision is readily discerned from a visual inspection of this GUI. Setting the trigger configuration is also done using this GUI 

The different signal going through the trigger scheme can be inspected in th Data-U6 oscilloscope. Simply right click on any of the wires to put that signal onto one of the four "Trigger Inspect" channels available at the patch panel of Data-U6, and connect that patch-panel cable to the oscilloscope. By inspecting the various delays, widths and overlaps the user trigger can be configured. The Trigger GUI is discussed in greater detail [[Trigger|here]].



==== Scaler Display ====
The GUI used to display scalers rates can be open from the icon **S800 Scalers** in the desktop of [[Software#u6pc5 (data U6)|u6pc5]]. Alternatively, open a terminal on u6pc5, and type **./goscalers** from directory **/user/s800/converged_daq/scalers**.

The GUI includes two pages labeled "s800" and "ratios". Page "s800" includes all the scaler channels; page "ratios" displays ratio values calculated between several pairs of channels. In addition, the GUI includes a panel showing the time evolution of the live time calculated from the live-to-raw trigger ratio, and the live-to-raw clock ratio. The figure below shows the page "ratios" from the scaler GUI.

A list of scaler channels can be found [[Scaler Channel Description|here]].

{{:wiki:Scalers.jpg?700|Scaler Display}}


==== Running in Slave mode with multilogger ====
The S800 DAQ can be run in Standalone mode (as described above), or in Slave mode. The later means that the S800 DAQ is controlled by an external DAQ (e.g. GRETINA). In this mode, the S800 ULM receives external clock and external synchronization  signals from the master DAQ. Running in Slave mode requires to change the script **CC0105Begin.tcl** in directory **/user/s800/converged_daq/Scripts**. In this file, there are two variables ''extsynch'' and ''extclock'' to define if the external synchronization and clock signals are enabled (=1) or disabled (=0). Make sure that you set these variables to 1 if you want to run in Slave mode.


By default, when running in Slave mode, data are recorded in the stagearea of the Master DAQ (experiment account). It is however possible to record simultaneously data from the S800 into the S800 stagearea, using the ''multilogger'' option (see ReadoutGUI figure above). The S800 ReadougGUI offers the possibility to record data from four different S800 ring-buffers: rawccusb, rawvmusb, s800built, and s800filter. The later is the most important since data from this ring buffer can be immediately processed by the S800 SpecTcl. 

When running XDT for an experiment with a Master DAQ (e.g. GRETINA), it is recommendable to run the S800 DAQ in Slave mode with the s800filter multilogger enabled. This can be done following the steps:

  * Click to the tab ''multilogger'' in the **ReadoutGUI**

  * Select the option "always record"

  * Click again on the tab ''multilogger'' and select "enable loggers". A window will pop out with a list of ring-buffers that can be muti-logged {{:wiki:multilogger.png|Multilogger window}}

  * Check out s800filter to enable recording data from this ring buffer

  * After this, S800 data from every run recorded by the experimenters, will also be recorded in the S800 stagearea.

  * After finishing XDT, it is better to disable the s800filter ring-buffer in the multilogger menu so the S800 stagearea doesn't record all data from the experiment.




===== Troubleshooting =====
There are several common reasons why the S800 DAQ may fail. The list below describes what to do to fix some of these problems.
  * [[#Old processes still running|Error message "Socket ID already in use"]]   
  * [[#No data sources defined|Error message "No data sources are running so a run cannot be started"]]
  * [[#CCUSB and/or VMUSB claimed by existing programs]]
  * [[#Manual rebooting]]



==== Old processes still running ====
Sometimes, particularly if the S800 DAQ session ended in an uncontrolled way (e.g. you tried to "kill" it), there may be old processes running (CCUSB and/or VMUSB and/or S800 event builder) that will prevent Readout GUI to begin a run. Whenever this happens (typically after clicking ''Begin'' in Readout GUI), the system sends an error message complaining about one of these processes still running (for instance "Socket ID already in use"). If you find yourself in this situation try:  
      - Exit your Readout GUI 
      - On a Linux session, connect to the S800 spdaq by typing ''ssh -Y s800@spdaqXX'' (Contact the Device Physicist to get the spdaq number XX and S800 password)
      - Type ''ps aux | grep Readout'' to ensure that Readout is indeed not running. If "Readout" is still running, use ''kill -9 PID'', where PID identifies the Readout process ID 
      - Type ''/usr/opt/nscldaq/xxxx/bin/ringbuffer status'', where xxxx is the daq version, e.g. 11.0-020
      - You will see a list of ringbuffers with information about their status (see figure below). Check that the producer value of each ringbuffer (see column ''producer'') is **-1**. (Don't worry about the ringbuffer **s800filter**, which is automatically killed when starting ReadoutGUI)
      - If the producer value of a ringbuffer is not -1, take note of the PID, and kill the process by typing ''kill -9 PID''
      - You should now be able to run Readout GUI and begin a run without problem


{{:wiki:ringbuffer1.png?650|Ringbuffer status}}

==== No data sources defined ====
When clicking ''Begin'' in the S800 Readout GUI, you get the error message: "No data sources are running so a run cannot be started". Very likely, the setting file **.settings.tcl** is missing. On a Linux session in u6pc5, type ''ls -lisa ~/stagearea''. You should see a hidden file **.settings.tcl**. If no, try the following:
      - Go to **/mnt/daqtesting/s800/exxxxlast**, where **exxxxlast** corresponds to the experiment number of the last (successfully) run experiment
      - Copy the file **.settings.tcl** from that directory to the current stagearea. **NOTE**: we are assuming that the stagearea is pointing to the new experiment directory **/mnt/daqtesting/s800/exxxxnew**
      - If you cannot find that file, there is an old version that can be copied from the directory **/user/s800/converged_daq**
      - You should now be able to run ReadoutGUI without problem 
==== CCUSB and/or VMUSB claimed by existing programs ====
One of the most common reasons why the S800 DAQ fails to start is because the CCUSB and/or VMUSB are claimed by existing programs. This is shown by the error messages displayed by the system. If you find yourself in this situation try the following:
      - Log on to S800 spdaq (spdaq19 as of October 2015)
      - Type ''ps aux | grep Readout''
      - Use ''kill -9 PID'', where PID identifies any CCUSBReadout or VMUSBReadout processes that show up
      - Use ''kill -9 PID'', where PID identifies any tclsh ReadoutShell process that might show up
      - Try ''godaq'' to see if this works now
      - If this didn't help try rebooting the S800 DAQ manually (see below)
==== Manual rebooting ====
In the rare case that the RunControl GUI gets "frozen", it is possible to reboot the whole system manually. This operation requires to turn off the VME and CAMAC crates, and the spdaq computer, all them located in the rack seating near the FP box in the S3 vault. Then, the system must be turned back on in the following order. First, CAMAC crate, second VME crate, and third spdaq.
S800 Documentation

User Tools

Site Tools

Page Tools
