File tree Expand file tree Collapse file tree 3 files changed +37
-1
lines changed
Expand file tree Collapse file tree 3 files changed +37
-1
lines changed Original file line number Diff line number Diff line change 11Package: slurmworkflow
22Title: Build workflows for the Slurm workload manager
33Version: 0.1.0
4- Date: 2023-04-04
4+ Date: 2023-04-05
55Authors@R:
66 c(person(given = "Adrien",
77 family = "Le Guillou",
Original file line number Diff line number Diff line change @@ -2,3 +2,38 @@ url: https://epimodel.github.io/slurmworkflow/
22template :
33 bootstrap : 5
44
5+ reference :
6+ - title : " Workflow Creation"
7+ desc : >
8+ Functions to create and edit a workflow
9+ contents :
10+ - create_workflow
11+ - add_workflow_step
12+
13+ - title : " Step Templates"
14+ desc : >
15+ Functions governing what is run by a step.
16+ They are to be used as argument to `add_workflow_step()`
17+ contents :
18+ - starts_with("step_tmpl")
19+
20+ - title : " Changing the Execution Order"
21+ desc : >
22+ Functions to query the currently running step and change the step to be run
23+ next.
24+ These functions are to be used inside a workflow running on an HPC. They
25+ allow conditional execution and loop like behavior.
26+ contents :
27+ - change_next_workflow_step
28+ - get_current_workflow_step
29+
30+ - title : " Utilities for Making Custom Step Templates"
31+ desc : >
32+ Functions used to create custom step templates from scratch.
33+ In most case, a new step template can be created as a wrapper around one of
34+ the existing templates.
35+ contents :
36+ - get_workflow_root
37+ - load_workflow
38+ - helper_use_setup_lines
39+ - helper_write_instructions
Original file line number Diff line number Diff line change @@ -31,6 +31,7 @@ Any HPC using [slurm](https://slurm.schedmd.com/) as its workload manager should
3131work with slurmworkflow.
3232
3333HPC tested:
34+
3435- [ Emory's RSPH HPC] ( https://sph.emory.edu/research/labs/index.html ) (in this
3536 vignette)
3637- [ Washington's HYAK
You can’t perform that action at this time.
0 commit comments