SwissFEL/sanipy
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
augustin_s
2020-09-22 13:31:38 +02:00
parent 3b473a3bf8
commit a292982473
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -6,6 +6,7 @@ It has two commands ([check](#check) and [compare](#compare)) and a few option s
The `data` folder contains some channel lists and output files for testing.
## check
`./sani.py check data/test_chans_good.txt`
@ -16,6 +17,8 @@ The `data` folder contains some channel lists and output files for testing.
<img src="docs/check_bad.png" width="491">
Successful connections will be marked in green, failed connection in red, and alarm states will be printed in yellow.
## compare
@ -27,4 +30,7 @@ The `data` folder contains some channel lists and output files for testing.
<img src="docs/compare_bad.png" width="658">
(Note here that `.csv` is automatically appended if missing.)
Entries that are identical in both files will not be shown. Differences will be printed as `LEFT | RIGHT`.
(Note that `.csv` is automatically appended to filenames if missing.)