From 27c095276c6a0674ad386eecf6ea68413ef1af5c Mon Sep 17 00:00:00 2001 From: Matthijs van der Wild Date: Tue, 8 Jul 2025 17:52:38 -0400 Subject: Document supported environment variables Pilot recognises some environment variables and uses them if they are set. This adds some text to the readme so it is clear for the user. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index f9c9219..da099dc 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,17 @@ Options can be the following: Use `single_machine` to run on the local node. * `` is the workflow file name without extension, e.g. `delay-calibration` or `concatenate-flag` for the VLBI pipeline or `HBA_calibrator` or `HBA_target` for LINC. +## Environment variables + +`pilot.sh` recognises and accepts the following environment variables if set by the user: + +* [`APPTAINERENV_PREPEND_PATH`](https://apptainer.org/docs/user/main/environment_and_metadata.html#manipulating-path); defaults to the scripts directory of the pipeline set by `-p`. +* [`APPTAINERENV_PYTHONPATH`](https://apptainer.org/docs/user/main/environment_and_metadata.html#apptainerenv-prefix); defaults to the scripts directory of the pipeline set by `-p`. +* [`APPTAINER_BIND`](https://apptainer.org/docs/user/main/environment_and_metadata.html#environment-from-the-apptainer-runtime); defaults to `$HOME,$BINDDIR,$OUTPUT_DIR`, where `$OUTPUT_DIR` is set with `--outdir`. +* `CWL_SINGULARITY_CACHE`; specifies the directory where toil can expect the software containers used by the pipeline. +* [`TOIL_SLURM_ARGS`](https://toil.readthedocs.io/en/latest/python/toilAPIBatchsystem.html#batch-system-environment-variables); defaults to `-p cosma5 -A durham -t 72:00:00`. +* [`TOIL_BATCH_LOGS_DIR`](https://toil.readthedocs.io/en/latest/appendices/environment_vars.html); defaults to `$OUTDIR/toil/logs`, where `$OUTDIR` is set with `--outdir`. + ## Notes * Upon successful pipeline completion the results directory contains the following: -- cgit v1.2.3