diff --git a/docs/ingestorManual.md b/docs/ingestorManual.md index 986d29a..e08ca52 100644 --- a/docs/ingestorManual.md +++ b/docs/ingestorManual.md @@ -142,7 +142,7 @@ There are backward compatible scripts in the [github repo](https://github.com/pa ### Important Update since April 14th 2022 For all commandline tools, like the datasetIngestor, datasetRetriever - etc, using your own user account you **have** to use the –token + etc, using your own user account you **have** to use the `--token` option with a predefined API token SCICAT-TOKEN. Specifying username/password is not possible for normal users (this limitation is caused by the switch to a new authentication protocol). The @@ -284,7 +284,7 @@ scicat-cli datasetIngestor --ingest metadata.json ``` For particularly important datasets, you may also want to use the -parameter –tapecopies 2 to store redundant copies of the data. +parameter `--tapecopies` 2 to store redundant copies of the data. To give some numbers, 0.2–0.4% of the tapes get damaged so there is a chance that archiving with only one copy will result in lost data, in very few cases. Keep in mind that archival with redundancy @@ -322,7 +322,7 @@ For Windows systems you can only use personal accounts and the data is always handled as `decentral` case, i.e. the data will first be copied from the windows machine to a central file server via scp first. Therefore you need to specify all of the above parameters --token, -user and -copy. +`--token`, `--user` and `--copy`. Please also note the syntax, that has to be used for the definition of the sourceFolder inside the metadata.json file: this has to be in the @@ -451,7 +451,7 @@ df1c7a17-2caa-41ee-af6e-c3cf4452af17 1893 p16371 /sls/MX/Data10/e16371/2017 ``` If you want you can skip the previous step and -directly trigger the file copy by adding the -retrieve flag: +directly trigger the file copy by adding the `--retrieve` flag: ```sh scicat-cli datasetRetriever --retrieve @@ -463,7 +463,7 @@ useful if you want to retrieve many datasets, which you expect to appear in the same folder structure as originally. Optionally you can also verify the consistency of the copied data by -using the `-chksum` flag +using the `--chksum` flag ```sh scicat-cli datasetRetriever --retrieve --chksum @@ -1202,7 +1202,7 @@ chosen for the same quantity: You will be prompted for your username and password. If everything looks as expected you should now repeat the command with - the "–ingest" flag to actually store the dataset(s) in the data + the `--ingest` flag to actually store the dataset(s) in the data catalog ```sh @@ -1214,7 +1214,7 @@ chosen for the same quantity: central cache file server). In addition you have the option to directly trigger the archiving of - the data to tape by adding the –autoarchive flag. Do this only if you + the data to tape by adding the `--autoarchive` flag. Do this only if you sure that this data is worth to be archived #### Use Case: Automated ingest of raw datasets from beamline or instruments @@ -1308,7 +1308,7 @@ scicat-cli datasetIngestor --autoarchive --copy --ingest metadata.json This command will copy the data to a central rsync server, from where the archive system can then copy the files to tape, in this case -(option -autoarchive) the copy to archive tapes will happen automatically +(option `--autoarchive`) the copy to archive tapes will happen automatically On recent versions of the datasetIngestor program the program detects automatically,if your data lies on central or decentral systems. In