aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index ba7adb8..883681a 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@ Issues should be reported to [Matthijs van der Wild](mailto:matthijs.van-der-wil
## Assumptions
This script assumes the following:
+
* All relevant input data is available either in either the `$HOME` directory or in a directory henceforth called `$BINDDIR`.
Targets of any links in these directories should be accessible to the compute directories, as these will be mounted during relevant jobs.
* The output will be written to a results directory in `$BINDDIR`.
@@ -23,6 +24,7 @@ The script can be run as follows:
sh pilot.sh [options] <workflow name> $BINDDIR
```
Options can be the following:
+
* `-h` prints the script usage with all available options (optional).
* `-r` restarts a failed pipeline, if this script was run before but the pipeline failed.
* `-c` allows the pipeline to use the specified container (optional, VLBI pipeline only).