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

Merged
merged 9 commits into from
Dec 2, 2024
Merged

Conversation

husensofteng
Copy link
Contributor

@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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks for the note, I have now removed this flag. I thought to keep the decision to the user!

Copy link
Member

Choose a reason for hiding this comment

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

It's better to keep it,= true actually,

Default is set to false!

// 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?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have already tested this and it works :)
yes, it will automatically create the cache directory if it doesn't exist

@jfy133
Copy link
Member

jfy133 commented Dec 2, 2024

Sorry @husensofteng I didn't see you were waiting for test execution approval.

So you don't need to wait next time, feel free to join the nf-core GitHub org as described on https://nf-co.re/join

@husensofteng
Copy link
Contributor Author

Sorry @husensofteng I didn't see you were waiting for test execution approval.

So you don't need to wait next time, feel free to join the nf-core GitHub org as described on https://nf-co.re/join

thank you, I just sent a request!

@husensofteng husensofteng merged commit 22ed496 into nf-core:master Dec 2, 2024
93 of 138 checks passed
}

// Load genome resources and assets hosted by the Bioinformatics team on IBEX cluster
includeConfig '/biocorelab/BIX/resources/configs/genomes.yaml'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jfy133 the profile does not recognize this statement, do you you have any suggestion how to make it work?
The purpose is to host a custom set of genome resources (similar to igenomes but locally maintained).

Copy link
Member

Choose a reason for hiding this comment

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

I think users would have to specify it with a custom config i.e. with -c... @maxulysse any ideas?

Copy link
Member

Choose a reason for hiding this comment

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

Unfortauntely this is breaking other pipeliens, so I'm commenting it out ofr now here: #810

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