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

New config profile KAUST #809

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

husensofteng
Copy link

@husensofteng husensofteng commented Dec 1, 2024


name: New Config for KAUST
about: A new cluster config for KAUST Ibex cluster

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

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
  • OPTIONAL: Add your custom profile path and GitHub user name to .github/CODEOWNERS (**/<custom-profile>** @<github-username>)

The purpose of this new config is to help users on the KAUST Ibex cluster to run nf-core workflows smoothly.

Thank you!

}

// Keep work directory after a successful run
cleanup = false
Copy link
Member

Choose a reason for hiding this comment

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

Be wary of this, if users don't clean up their work directories manually and regularly, you may have very filled up hard drives very quickly

Nf-core pipelines come with a debug profile that can turn this off if necessary

// Use existing images from the centralized library, if available
libraryDir = "/biocorelab/BIX/resources/singularity/images/"
// Download images that are missing from the library to user space
cacheDir = "/home/$USER/.singularity/nf_images/"
Copy link
Member

Choose a reason for hiding this comment

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

Please double check this works and nextflow doesn't try to resolve the variable [rather than bash] (this can happen in some of the config sections)

Copy link
Member

Choose a reason for hiding this comment

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

And does the cache directory already exist for all users?

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