Skip to content

Refactor for advanced workflows and update cluster basics#3

Merged
juliendrapeau merged 3 commits into
mainfrom
dev
May 8, 2026
Merged

Refactor for advanced workflows and update cluster basics#3
juliendrapeau merged 3 commits into
mainfrom
dev

Conversation

@juliendrapeau
Copy link
Copy Markdown
Collaborator

@juliendrapeau juliendrapeau commented May 6, 2026

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:

  • Added a new 01-cluster-basics/README.md with a step-by-step beginner guide for connecting, transferring files, and submitting jobs on HPC clusters, including cluster overviews and links to official resources.
  • Rewrote the main README.md to provide a high-level overview and clear navigation through the repository, pointing users to the new modular guides.
  • Added new introductory guides for containers (02-docker-apptainer/README.md) and workflow automation with Snakemake (03-snakemake/README.md). [1] [2]

SSH setup and configuration:

  • Introduced an SSH quick start guide (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:

  • Updated SLURM script templates (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:

  • Moved and renamed files for a clearer structure, grouping scripts and documentation by topic and removing redundant or outdated explanations (e.g., more_on_shell_scripts/README.md was removed in favor of the new guides). [1] [2] [3] [4] [5]

References:
[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]

@juliendrapeau juliendrapeau merged commit 701e0d0 into main May 8, 2026
Copy link
Copy Markdown
Collaborator

@JeremieGince JeremieGince left a comment

Choose a reason for hiding this comment

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

This is a great PR, minor changes required.

Comment thread 01-cluster-basics/README.md
Comment thread 01-cluster-basics/README.md
Comment thread 01-cluster-basics/README.md
@juliendrapeau
Copy link
Copy Markdown
Collaborator Author

Agreed on all counts. PR #8 addresses these comments.

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.

link to calcul-haute-performance-iq-sherbrooke github is broken

2 participants