Skip to content

Commit 66d9825

Browse files
authored
docs: updated for passing commands as script (#392)
This PR merely updates the documentation section and describes the `--slurm-pass-command-as-script` flag. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated SLURM configuration documentation with details on the --slurm-pass-command-as-script option for submitting job commands via temporary shell scripts. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent ccde8ca commit 66d9825

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/further.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,12 @@ If you do not deliberately set the snakemake resource `slurm_account`, the plugi
254254
By contrast, some clusters _do not_ allow users to set their account or partition; for example, because they have a pre-defined default per user.
255255
In such cases, where the plugin's default behavior would interfere with your setup or requirements, you can use the `--slurm-no-account` flag to turn it off.
256256

257+
##### Passing Commands as Scripts: `--slurm-pass-command-as-script`
258+
259+
When this flag is enabled, the command that Snakemake would normally pass directly to `sbatch` via the `--wrap` option is instead written into a small temporary shell script which is submitted with `sbatch <script>`.
260+
261+
Why this exists: Some SLURM installations or cluster configurations impose limits on the length or characters allowed in the `--wrap` argument or inlined command strings. This happens when administrators deliberately set the `slurm_max_submit_line_size` in their SLURM configuration to a low value. Passing the job command as a script avoids those limitations.
262+
257263
##### Wait Times and Frequencies
258264

259265
There are a number of wait times and frequencies that users can tune to their local cluster setup.

0 commit comments

Comments
 (0)