leverington/tdc_gpx2
1
0
Fork 0
Code Issues Pull Requests repo.project_board Releases Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
Blake Leverington 2023-08-11 14:16:55 +02:00
parent f42ffaed3d
commit 9bceb6f24e
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -7,8 +7,10 @@ Files for building readout software for the TDC-GPX2 from ScioSense.
| ------ | ----------- | | ------ | ----------- |
| source/gpx2-raspi-readout-program| Contains a readout loop, buffer and calculations to measure time intervals between two signals with good accuracy. | source/gpx2-raspi-readout-program| Contains a readout loop, buffer and calculations to measure time intervals between two signals with good accuracy.
| source/spi | Folder containing gpx2 source files for making the tdc board library containing all options and an high level access for readout. | source/spi | Folder containing gpx2 source files for making the tdc board library containing all options and an high level access for readout.
| source/gpx2-fpga | tba | | scripts | python script makes a histogram of the output. requires matplotlib|
| data | empty folder for output|
<br> <br>
<strong>Readout via SPI:</strong> <strong>Readout via SPI:</strong>
Required: Required:
@ -16,9 +18,22 @@ Required:
- up-to-date c++ compiler (C++17 compatible), tested with clang 11 and newer - up-to-date c++ compiler (C++17 compatible), tested with clang 11 and newer
How to build: How to build:
- This software packages is build with cmake - requires cmake
- builds the gpx2 library and optionally the readout program - builds the gpx2 library and optionally the readout program
<br> ```sh
<strong>Readout via LVDS using an FPGA:</strong><br> cd source
coming soon mkdir build
cd build
cmake ..
cmake --build .
```
to run the code:
```
/// outputs to stdout
./bin/readout
///redirect to file
./bin/readout > ../data/test_out.data
```