Refactor for advanced workflows and update cluster basics#3
Merged
Conversation
JeremieGince
reviewed
May 8, 2026
Collaborator
JeremieGince
left a comment
There was a problem hiding this comment.
This is a great PR, minor changes required.
Collaborator
Author
|
Agreed on all counts. PR #8 addresses these comments. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request reorganizes and modernizes the HPC onboarding documentation, adding new beginner-friendly guides, improving SSH setup instructions, updating SLURM script templates, and introducing sections on containers and workflow automation. The changes aim to streamline the onboarding process, clarify best practices, and provide ready-to-use scripts and configs.
Resolves #2.
Major documentation improvements:
01-cluster-basics/README.mdwith a step-by-step beginner guide for connecting, transferring files, and submitting jobs on HPC clusters, including cluster overviews and links to official resources.README.mdto provide a high-level overview and clear navigation through the repository, pointing users to the new modular guides.02-docker-apptainer/README.md) and workflow automation with Snakemake (03-snakemake/README.md). [1] [2]SSH setup and configuration:
ssh/README.md) and a sample SSH config file (ssh/config) to simplify secure, passwordless access to clusters using aliases and key management. [1] [2]SLURM job script updates:
base_script.sh,advanced_script.sh,advanced_script_gpus.sh) to reflect current cluster partition names, Python versions, and best practices for virtual environments and GPU usage. (Fafe8724R1, [1] [2] [3] [4]Content reorganization and cleanup:
more_on_shell_scripts/README.mdwas removed in favor of the new guides). [1] [2] [3] [4] [5]References:
[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]