Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ Run the workflow with:
snakemake --cores 2 --sdm conda apptainer --directory .test
```

## The "profiles" Directory
Comment thread
dlaehnemann marked this conversation as resolved.
Outdated

When developing on a cluster or cloud instance, please include a "profiles" directory:

`profiles/<cluster or cloud name>/config.yaml`

This configuration file should contain the workflow profile with its resource specification for a particular execution environment (cluster or cload). You may include a readme file next to point out pitfalls or other aspects worth a user's consideration.
Comment thread
cmeesters marked this conversation as resolved.
Outdated

## Authors

- Firstname Lastname
Expand Down
9 changes: 9 additions & 0 deletions profiles/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
A 'profiles' directory might contain workflow resource configuration for a particular cluster or cloud instance.

We encourage to include a profile for your use case as:

`profiles/<your cluster or cloud instance>/config.yaml`

You may include a readme file next to the config.yaml file to point out pitfalls or other things to consider.
Comment thread
dlaehnemann marked this conversation as resolved.
Outdated

Feel free to open pull requests for 3rd party workflows you are working with to include such a profile! It might also be necessary to occasionally label certain rules of a particular workflow with the `localrules: <rule 1>, <rule 2>, ...` directive when workflow developers focussed on server execution during development, e.g. plotting and dowload rules.
Comment thread
cmeesters marked this conversation as resolved.
Outdated
Loading