From 85c227292f2ae57d30671b4a88225ba5366deecc Mon Sep 17 00:00:00 2001 From: augustin_s Date: Fri, 27 Oct 2023 11:39:09 +0200 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4c69a54..97d1ac8 100644 --- a/README.md +++ b/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 ```