From 120c2c187aa6393d032a418061e6243bf6ea25e4 Mon Sep 17 00:00:00 2001
From: Guenter Quast <guenter.quast@kit.edu>
Date: Sun, 9 Jun 2024 23:33:29 +0200
Subject: [PATCH] morer complete documentation
---
README.md | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 7b59f6b..bd85db4 100644
--- a/README.md
+++ b/README.md
@@ -26,14 +26,17 @@ the server and pulls the data to the client computer.
- *README.md* this documentation
- *mchpa.py* client program
- - *rePoscidaq.py* a simple oscilloscope and daq client using the mcpha server
- - *rpControl.ui* qt5 tab for *redPosci* application
- - *mcpha_daq.ui* qt5 tab for oscilloscope with daq mode
+ - *redPoscidaq.py* a simple oscilloscope and daq client using the mcpha server
+ - *examples/* recorded spectra
+ - *examples/peakFitter.py* code to find and fit peaks in spectum data
+ - *read_npy.py* a simple example to read waveforms saved in *.npy* format
- *redP_mimocorb.py* runs *redPoscdaq* as a client of the buffer manager *mimoCoRB*
- - *setup.yaml* coniguration script defining the *mimoCoRB* application
- *run_daq.py* script to strat the *mimoCoRB* application
+ - *setup.yaml* coniguration script defining the *mimoCoRB* application
- *modules/* and *config/* contain code and configuration files for the *redP_mimoCoRB* application
- *mcpha.ui* qt5 graphical user interface for *mcpha* application
+ - *rpControl.ui* qt5 tab for *redPosci* application
+ - *mcpha_daq.ui* qt5 tab for oscilloscope with daq mode
- *mcpha_gen.ui* qt5 tab for generator
- *mcpha_osc.ui* qt5 tab for oscilloscope
- *mcpha_hst.ui* qt5 tab for histogram display
@@ -194,20 +197,21 @@ Note that presently mcpha.py exports data in human-readable format using
frequency and the rise and fall times specified in the graphical interface. The signals are
available at the *out1* connector of the RedPitaya board.
>
- > Pulses can be generated at a fixed frequency, or with random timing corresponding to a
+ > Pulses can be generated at a fixed frequency, or with random timing corresponding to a
Poisson process with a mean pulse rate given by the chosen frequency. The latter option is
useful to study "pile-up" effects from overlapping pulses.
-> *read_hst.py* illustrates how to read and plot spectrum data exported by mcpha.py.
+ > *read_hst.py* illustrates how to read and plot spectrum data exported by mcpha.py.
-> *read_osc.py* demonstrates how to read and plot waveform data exported from the
- oscilloscope tab of mcpha.py.
+ > *read_osc.py* demonstrates how to read and plot waveform data exported from the
+ oscilloscope tab of mcpha.py.
## Examples
The directory *examples/* contains some spectra recorded with *mchph.py* and the Python
program *peakFitter.py* to find and precisely fit peaks in recorded spectra. An example is
shown here:
+
{width=800px}
--
GitLab