From 64e430cd7f16f250490ca22d0322a9340068657b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?G=C3=BCnter=20Quast?= <guenter.quast@online.de>
Date: Thu, 20 Jun 2024 11:13:03 +0200
Subject: [PATCH] added documentation to the script header
---
redP_mimoCoRB.py | 22 ++++++++++++++++++++--
1 file changed, 20 insertions(+), 2 deletions(-)
diff --git a/redP_mimoCoRB.py b/redP_mimoCoRB.py
index c729eea..76f1e34 100644
--- a/redP_mimoCoRB.py
+++ b/redP_mimoCoRB.py
@@ -2,7 +2,25 @@
**redP_mimoCoRB**: use mimoCoRB with the RedPitaya and redPoscdaq.py
Input data is provided as numpy-arry of shape (number_of_channels, number_of_samples)
-via callback of function data_sink() in class redP_mimoCoRB.
+via callback of the __call__() function in class redP_mimoCoRB.
+
+This script depends on redPdaq.py and is started as a sup-process within the mimoCoRB
+framework. The detailes set-up of ring buffers and the associated funtions is specified
+in a configuration file in *.yaml* format. The process suite is started using the script
+start-up script from the *mimiCoRB* package, *run_daq.py*, a copy of which is provided
+as part of this package.
+
+As a demonstration, a configuration *setup.yaml* is contained in this package to
+import waveforms from the RedPitaya, display a sub-set of the waveforms and perform
+a pulse-height analysis with updating results shown as histograms.
+To run this example, connect the out1 of the RedPitaya to one or both of the inputs,
+type "./run_daq.py* and use the graphical interface to connect the RedPitaya to the
+network, start the pulse generator, and finally press the *StartDAQ" button in the
+oscilloscope tag to start data transfer to the *mimiCoRB* input buffer.
+
+Stop data taking with the button "End run" in the *mimoCoRB* conotrol window to
+cleanly shut down all processes.
+
"""
import time
@@ -36,7 +54,7 @@ class redP_mimocorb():
def redP_to_rb(source_list=None, sink_list=None, observe_list=None, config_dict=None, **rb_info):
"""Main function,
- executed as a multiprocessing Process, to pass data from RedPitaya to a mimoCoRB buffer
+ executed as a multiprocessing Process, to pass data from the RedPitaya to a mimoCoRB buffer
:param config_dict: configuration dictionary
- events_required: number of events to be taken
--
GitLab