Skip to content

Commit 6971446

Browse files
docs: update prefix setting description
1 parent 7dffbb1 commit 6971446

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/further.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,21 @@ shared-fs-usage:
1818
- source-cache
1919
```
2020
21-
If the shared scratch is e.g. specific for each job (e.g. controlled by a ``$JOBID``). Environment variables defined only on remote instances might need to be escaped (with a `\`) to prevent premature evaluation. One can define a job-specific local storage prefix like this
21+
If the shared scratch is e.g. specific for each job (e.g. controlled by a ``$JOBID``) one can define a job-specific local storage prefix like this
2222
2323
```yaml
2424
default-storage-provider: fs
2525
local-storage-prefix: /local/work/$USER
26-
remote-job-local-storage-prefix: /local/work/$USER/\$JOBID
26+
remote-job-local-storage-prefix: /local/work/$USER/$JOBID
2727
shared-fs-usage:
2828
- persistence
2929
- software-deployment
3030
- sources
3131
- source-cache
3232
```
3333
34+
Note that when using ``snakemake-interface-executor-plugins<9.3.4``, the variable ``$JOBID`` has to be escaped as ``\$JOBID`` because of a bug.
35+
The bug is fixed in ``snakemake-interface-executor-plugins>=9.3.4``. We recommend an update.
36+
3437
Note that the non-remote job local storage prefix is still always needed, because Snakemake can also decide to run certain jobs without submission to the cluster or cloud.
35-
This can happen either on dev request because a certain rule is very lightweight, or by Snakemake's own decision, e.g. in case of rules that just format a template (see `docs <https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#template-rendering-integration>`_).
38+
This can happen either on dev request because a certain rule is very lightweight, or by Snakemake's own decision, e.g. in case of rules that just format a template (see `docs <https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#template-rendering-integration>`_).

0 commit comments

Comments
 (0)