Commit e2d42ab2c5289337af065c046ba153b927ccc745

Authored by bmarechal
1 parent 3c94f78ab0
Exists in master

add readme

Showing 1 changed file with 25 additions and 1 deletions Inline Diff

# allanplot 1 1 # Description
2
3 Compute and plot Allan Deviation from tab separated values files.
4
5 # Usage
6
7 `python allanplot.py --help`
8
9 usage: allanplot.py [-h] [-f FILENAME] [-c COLUMNS [COLUMNS ...]] [-r RATE]
10
11 Plot Allan Deviation from timeseries file
12
13 optional arguments:
14 -h, --help show this help message and exit
15 -f FILENAME File(s) to import (default *.dat)
16 -c COLUMNS [COLUMNS ...]
17 Columns to import (default 2)
18 -r RATE Time rate in seconds (default 1)
19
20 Example: './allanplot.py -f 'toto.dat' -c 2 3' compute and plot Allan
21 Deviation form columns 2 and 3 of toto.dat
22
23 # Examples
24
25 `python allanplot.py -f '**/*.dat` will load all dat files in all sub-directories of the current path.
2 26