Skip to content
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

Add University of Dundee cluster config #568

Merged
merged 3 commits into from
Oct 12, 2023
Merged

Conversation

dsloanm-uodit
Copy link
Contributor

@dsloanm-uodit dsloanm-uodit commented Oct 12, 2023


name: New Config
about: A new cluster config

A workaround for nextflow-io/nextflow#2449 is included in the config file. Following the approach at https://github.com/nf-core/configs/blob/9c4830c/conf/hebbe.config#L16-L17

Please follow these steps before submitting your PR:

  • If your PR is a work in progress, include [WIP] in its title
  • Your PR targets the master branch
  • You've included links to relevant issues, if any
  • Requested review from @nf-core/maintainers and/or #request-review on slack

Steps for adding a new config profile:

  • Add your custom config file to the conf/ directory
  • Add your documentation file to the docs/ directory
  • Add your custom profile to the nfcore_custom.config file in the top-level directory
  • Add your custom profile to the README.md file in the top-level directory
  • Add your profile name to the profile: scope in .github/workflows/main.yml

Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Theoretically OK, however you've not specified any software environment system which is also quite important (conda, docker, singularity etc.). I see you ask people to use conda to install Nextflow itself, is that the only engine available? If so I would turn that on in the config too

@dsloanm-uodit
Copy link
Contributor Author

Thanks for the comments - I have explicitly enabled conda in the config. Ideally we would like to use Singularity but our compute nodes aren't quite set up for it yet. It's something we're aiming for, however.

@jfy133
Copy link
Member

jfy133 commented Oct 12, 2023

One last thing to document: I would recommend users specifying a NXF_CONDA_CACHEDIR env variable so they don't create the same conda environments for every run

@dsloanm-uodit
Copy link
Contributor Author

I've added some notes on NXF_CONDA_CACHEDIR (and fixed a typo in a section header). Thanks again

@jfy133
Copy link
Member

jfy133 commented Oct 12, 2023

Will wait for tests to pass the nwill merge 👍

@jfy133 jfy133 merged commit e7c5333 into nf-core:master Oct 12, 2023
103 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants