New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Blog: Tweak config examples #115
Conversation
✅ Deploy Preview for nextflow-staging ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Thanks for these corrections, @ewels. The changes look good to me. I can see where it makes more sense to specify the settings in the config file. I notice in the documentation settings often appear in the process block in the workflow itself, but maybe this is just for ease of explanation, or these haven't been updated yet. https://nextflow.io/docs/latest/process.html#process-cpus |
Yeah, that's because they are process directives - so they sit in the documentation for processes. The config docs just says "you can do all the process directives". It's not wrong to do it in the process, just that we typically don't consider it best practice. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@GJSissons NB couple of other more subtle changes highlighted 👇🏻
content/blog/2023/best-practices-deploying-pipelines-with-hpc-workload-managers.md
Show resolved
Hide resolved
@@ -327,8 +321,7 @@ $ cat submit_pipeline.sh | |||
#BSUB -e err.%J | |||
#BSUB -J headjob | |||
#BSUB -R "rusage[mem=16GB]" | |||
export NFX_OPTS="-Xms=512m -Xmx=8g" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed as this isn't explained until the following section. Alternatively could reorder the sections, or just leave it here without explanation is probably fine too.
I personally found the mix of configuration within script
process
blocks and configprocess
scopes confusing. We always say that it's best practice to never specify this stuff within a script, but always do it in a config file - that way it's easier to overwrite and make the pipeline portable. As such, I updated the examples to all use only configs and not script syntax.One or two other minor tweaks.