Update README.md
This commit is contained in:
22
README.md
22
README.md
@ -37,11 +37,25 @@ usage: unarchived_data_fix.py [-h] [--no-dryrun] [--inplace] [--overwrite]
|
||||
|
||||
positional arguments:
|
||||
{alvra,bernina,cristallina,diavolezza,maloja,furka}
|
||||
pgroup
|
||||
Which instrument has the data been measured at?
|
||||
pgroup Which pgroup is the data in?
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
--no-dryrun
|
||||
--inplace
|
||||
--overwrite
|
||||
--no-dryrun Disable dry run. If dryrun is enabled (default) no
|
||||
files are written.
|
||||
--inplace Update scan.json in place. If inplace is disabled
|
||||
(default) a new file scan_mod.json is created.
|
||||
--overwrite Overwrite existing files. If overwrite is disabled
|
||||
(default) existing files will be skipped.
|
||||
|
||||
usage examples:
|
||||
Dry run (nothing is changed or overwritten)
|
||||
unarchived_data_fix.py alvra p12345
|
||||
|
||||
Create new files called scan_mod.json
|
||||
unarchived_data_fix.py alvra p12345 --no-dryrun
|
||||
|
||||
Overwrite scan.json
|
||||
unarchived_data_fix.py alvra p12345 --no-dryrun --overwrite --inplace
|
||||
```
|
||||
|
Reference in New Issue
Block a user