Skip to content

Commit 1d631dd

Browse files
authored
add usage instructions
1 parent c9efb00 commit 1d631dd

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
1-
# h5-peeker
1+
# analysis-toolkit
22
a tool for peeking at beam diagnostic data in a hdf5 file
3+
4+
## CLI interface usage
5+
```
6+
$ ./cli.py --help
7+
usage: cli.py [-h] [--draw-plots] [--no-spot-fit] [--database DATABASE]
8+
[--freeze-file FREEZEOBJ] [-v]
9+
[input [input ...]]
10+
11+
Peek at beam diagnostic data in hdf5 files
12+
13+
positional arguments:
14+
input File(s) to process
15+
16+
optional arguments:
17+
-h, --help show this help message and exit
18+
--draw-plots Draw analysis plots or each file processed
19+
--no-spot-fit Do not fit camera data to 2D gaussian
20+
--database DATABASE Save/append analysis data to this sqlite database file
21+
--freeze-file FREEZEOBJ
22+
Freeze/draw data to a .csv file
23+
-v, --verbose Dump everything to the terminal during analysis
24+
```

0 commit comments

Comments
 (0)