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 configurations for GIGA and CÉCI clusters #779

Merged
merged 24 commits into from
Oct 28, 2024

Conversation

MartinGrignard
Copy link
Contributor


name: GIGA, CÉCI NIC5 and CÉCI Dragon2 Configs
about: Three new cluster configurations for the GIGA and CÉCI.

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>)

Summary

This PR adds the three following configuration profiles:

@jfy133
Copy link
Member

jfy133 commented Oct 24, 2024

Hi @MartinGrignard !

Thanks for the PR! I the meantime please also join the nf-core github orgnaisation with instructions here: https://nf-co.re/join

So we don't have to wait someone to manually use the tests and also get the code owners file to work :)

@jfy133
Copy link
Member

jfy133 commented Oct 24, 2024

@nf-core-bot fix linting

conf/ceci_dragon2.config Show resolved Hide resolved
conf/ceci_nic5.config Show resolved Hide resolved
conf/giga.config Show resolved Hide resolved
docs/ceci_dragon2.md Outdated Show resolved Hide resolved

```bash
# Load modules
module load 'Nextflow/24.04.2'
Copy link
Member

Choose a reason for hiding this comment

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

Does singularity also need to be laoded, or is this available by default?

Also the dragon2 config doesn't specify a singualrity cache directory, if users need to do this manually maybe document to specify this with the nextflow NXF_SINGULARITY_CACHEDIR (https://nextflow.io/docs/latest/reference/env-vars.html) so they at least can cache on a per-user basis

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, the singularity command is available by default on both CÉCI clusters (Dragon2 and NIC5).

Since there is no shared directory that I am aware of on those clusters, is this recommended to still specify it to something like ${HOME}/.cache/singularity? Or is it okay to leave it empty so that the system uses its default value?

Copy link
Member

Choose a reason for hiding this comment

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

It is recommended to specify a directory with NXF_SINGULARITY_CACHE_DIR as the 'default' by Nextflow is to pull the images into the work/ directory, which is run specific. On the next run where -w is somewhere else it'll download the images again

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 information, I added a default cache directory (for consistency across all users). If, in the future, a shared directory is created on these clusters, I'll document how to use it/switch to it.

@jfy133
Copy link
Member

jfy133 commented Oct 24, 2024

The formatting failures:

conf/ceci_dragon2.config:
	72: Trailing whitespace
conf/ceci_nic5.config:
	73: Trailing whitespace

2 errors found


CODEOWNERS validator.....................................................Passed
pre-commit hook(s) made changes.
If you are seeing this message in CI, reproduce locally with: `pre-commit run --all-files`.
To run `pre-commit` as part of git workflow, use `pre-commit install`.
All changes made by hooks:
diff --git a/docs/ceci_dragon2.md b/docs/ceci_dragon2.md
index 30b1a49..3817e91 100644
--- a/docs/ceci_dragon2.md
+++ b/docs/ceci_dragon2.md
@@ -17,4 +17,5 @@ module load 'Nextflow/24.04.2'
---
-*Built with* ❤️ *by the [GIGA Bioinformatics Team](https://www.gigabioinformatics.uliege.be/cms/c_8464757/en/gigabioinformatics)*
+
+_Built with_ ❤️ _by the [GIGA Bioinformatics Team](https://www.gigabioinformatics.uliege.be/cms/c_8464757/en/gigabioinformatics)_
diff --git a/docs/ceci_nic5.md b/docs/ceci_nic5.md
index e9743f6..e46ad83 100644
--- a/docs/ceci_nic5.md
+++ b/docs/ceci_nic5.md
@@ -17,4 +17,5 @@ module load 'Nextflow/21.08.0'


---
-*Built with* ❤️ *by the [GIGA Bioinformatics Team](https://www.gigabioinformatics.uliege.be/cms/c_8464757/en/gigabioinformatics)*
+
+_Built with_ ❤️ _by the [GIGA Bioinformatics Team](https://www.gigabioinformatics.uliege.be/cms/c_8464757/en/gigabioinformatics)_
diff --git a/docs/giga.md b/docs/giga.md
index b14c96b..09c619e 100644
--- a/docs/giga.md
+++ b/docs/giga.md
@@ -26,4 +26,5 @@ module load 'nextflow/24.04.4'


---
-*Built with* ❤️ *by the [GIGA Bioinformatics Team](https://www.gigabioinformatics.uliege.be/cms/c_8464757/en/gigabioinformatics)*
+
+_Built with_ ❤️ _by the [GIGA Bioinformatics Team](https://www.gigabioinformatics.uliege.be/cms/c_8464757/en/gigabioinformatics)_

@MartinGrignard
Copy link
Contributor Author

Hi @MartinGrignard !

Thanks for the PR! I the meantime please also join the nf-core github orgnaisation with instructions here: https://nf-co.re/join

So we don't have to wait someone to manually use the tests and also get the code owners file to work :)

I just posted my request on the #github-invitations channel of the slack workspace.

MartinGrignard and others added 2 commits October 24, 2024 12:58
Replaced `configuraiton` by `configuration`.

Co-authored-by: James A. Fellows Yates <[email protected]>
@jfy133
Copy link
Member

jfy133 commented Oct 27, 2024

@MartinGrignard you'll need to accept the invitation by the email or by going to https://github.com/orgs/nf-core/

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.

One further optimisation you could do is collapse the multiple params blocks into one (the info and old max_* resource limitations), but not a blocker

conf/ceci_dragon2.config Outdated Show resolved Hide resolved
conf/ceci_nic5.config Outdated Show resolved Hide resolved
@MartinGrignard MartinGrignard merged commit 93b4be7 into nf-core:master Oct 28, 2024
136 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.

3 participants