GUI UPDATED v1.3.1 30/5/2022: In Pairs mode, the counts graph now shows individual channel counts, while the numbers on the right of the graph display coincidences between channels (from top to bottom) 1-3, 1-4, 2-3, 2-4.
INFO
- This program is a Graphical User Interface (GUI) for s-fifteen intruments' TDC1 Timestamp Device https://s-fifteen.com/products/timestamp.
CONTACT
- For any bug reports/suggestions, please contact the developer at info@s-fifteen.com or g3.ganjunherng@gmail.com.
- It would be helpful if you included the error messages printed out to the terminal or whatever program that is catching the errors. (Do not worry if you cannot find this.)
INSTALLATION QUICKSTART
Install the S15lib python package directly with
pip install git+https://github.com/s-fifteen-instruments/pyS15.git
Alternatively you can clone or download the package from https://github.com/s-fifteen-instruments/pyS15.git. Open a command-line terminal, go into the repository folder and type
pip install -e .
- Full installation instructions at https://github.com/s-fifteen-instruments/pyS15.
- Other python package requirements: see file 'requirements.txt'. Install with pip or preferred mode of installation.
- Run tdc1_funcnew.py with your Python compiler of choice (This GUI was developed in Visual Studio Code with Python 3.9.2 64-bit).
HOW TO USE
-
Ensure device is connected to PC.
-
Select Device from drop down menu.
-
Select GUI Mode - singles/pairs. (This is NOT equivalent to the TDC1 mode. For instance the pairs mode uses the TDC1's timestamp mode (3) for its g2 calculations. The modes correspond to the graph tabs - singles:counts, pairs:coincidences.)
-
Select a Logfile if logging is desired. It is best to write the data to a new, blank Logfile. Leave field empty if not desired.
-
Select Integration time (singles) / acquisition time (pairs) by pressing the arrows or typing in manually then hitting enter.
-
Select Plot Samples. This determines how many data points to display on the graph at once. Only works for pairs mode. Singles mode plots up to 500 data points by design.
-
The timer checkbox can be selected for a finite experiment runtime.
-
Hit 'Live Start' button.
-
If in Singles mode, select the respective radio buttons to see the plots.
-
If in Pairs mode, select start and stop channel (Default Start:1, Stop:3), histogram bin width.
-
If in pairs mode, switch to the 'coincidences' tab to view the histogram. The value in the 'Stop Ch offset' spinbox allows you to set a software delay for coincidence counting.
-
Use mouse to interact with the graph - Click and drag to pan, scroll to zoom, right click for more viewing options. The graph will not auto-scroll if you do this. To return to auto-scroll mode, right click and look for the 'Auto' radio button under the X axis or Y axis context menus.
-
Right clicking on the graph and clicking on 'export...' brings up an options window for exporting the graph.
-
To begin a new round of data collection, click the 'Clear Data' button on the respective graphs.
-
The GUI is under continual development and may bug out if certain buttons are clicked too many times or clicked in unexpected order. Please report any errors to the contact addresses listed at the top of this README. Meanwhile, simply closing and restarting the GUI should fix the errors. These are usually due to certain background flags that have not been set to the right state. Restarting the GUI sets all the flags to their default state and you may begin again from a clean slate.