Skip to content

Latest commit

 

History

History
95 lines (75 loc) · 5.71 KB

lesson-outline.md

File metadata and controls

95 lines (75 loc) · 5.71 KB
layout title
page
Introduction to HPC Lesson Outline

How to use this outline

The following list of items is meant as a guide on what content should go where in this repo. This should work as a guide where you can contribute. If a bullet point is prefixed by a file name, this is the lesson where the listed content should go into. This document is meant as a concept map converted into a flow learning goals and questions.

Using a Compute Cluster for Research

  • Prelude

    • User profiles (academic and/or commercial) of cluster users
    • Narrative introduction

  • 11-hpc-intro.md: Intro to Cluster Computing: Fundamentals of clusters and their resources resources (brief, concentrate on the concepts not details like interconnect type etc)

    • Be able to describe what a compute cluster (HPC/HTC system) is
    • Explain how a cluster differs from a laptop, desktop, cloud, or "server"
    • Identify how an compute cluster could benefit you.
    • Jargon busting

  • 12-cluster.md: Accessing the Cluster

    • Understand the purpose of using a terminal program and SSH
    • Learn the basics of working on a remote system
    • Know the differences of between login and compute nodes
    • Objectives: Connect to a cluster using ssh; Transfer files to and from the cluster; Run the hostname command on a compute node of the cluster.
    • Potential tools: ssh, ls, hostname, logout, nproc, free, scp, man, w

  • 13-scheduler.md: Working with the Scheduler: Lesson will cover SLURM by default, other schedulers are planned. From hpc-in-a-day we know that material comprising Slurm, PBS and LSF is possible, but hard already as e.g. PBS doesn't support direct dispatchment as srun.

    • Know how to submit a program and batch scrip to the cluster (interactive & batch)
    • Use the batch system command line tools to monitor the execution of your job.
    • Inspect the output and error files of your jobs.
    • Potential tools: shell script, sbatch, squeue -u, watch, -N, -n, -c, --mem, --time, scancel, srun, --x11 --pty,
    • Extras: --mail-user, --mail-type,
    • Remove? watch,
    • Later lessons? -N -n -c

  • 14-modules.md: Accessing Software

    • Understand the runtime environment at login
    • Learn how software modules can modify your environment
    • Learn how modules prevent problems and promote reproducibility
    • Objectives: how to load and use a software package.
    • Tools: module avail, module load, which, echo $PATH, module list, module unload, module purge, .bashrc, .bash_profile, git clone, make,
    • Remove: make, git clone,
    • Extras: .bashrc, .bash_profile

  • [15-Filesystems and Storage]: This topic didn't get fleshed out in the call. But objectives likely include items from PStein's Shared Filesystem lesson:

    • Understand the difference between a local and shared/network filesystem
    • Learn about high performance / scratch Filesystems
    • Raise the attention that misuse (intentional or not) of a common file system neatively affects all users very quickly.
    • Possible tools: echo $TEMP, ls -al /tmp, df, quota

  • 15-transferring-files.md: Transferring Files

    • Understand the (cognitive) limitations that remote systems don't necessarily have local Finder/Explorer windows
    • Be mindful of network and speed restrictions (e.g. cannot push from cluster; many files vs one archive)
    • Know what tools can be used for file transfers, and transfer modes (binary vs text)
    • Objective: Be able to transfer files to and from a computing cluster.
    • Tools: wget, scp, rsync (callout), mkdir, FileZilla,
    • Remove: dos2unix, unix2dos,
    • Bonus: gzip, tar, dos2unix, cat, unix2dos, sftp, pwd, lpwd, put, get,
    • Later:

  • 16-resources.md: Using Resources Effectively

    • Understand how to look up job statistics
    • Learn how to use job statistics to understand the health of your jobs
    • Learn some very basic techniques to monitor / profile code execution.
    • Understand job size and resource request implications.
    • Tools: fastqc, sacct, ssh, top, free, ps, kill, killall (note that some of these may not be appropriate on shared systems)

Previous lesson ideas, up for debate

  • Playing friendly in the cluster (psteinb: the following is very tricky as it is site dependent, I personally would like to see it in _extras)

    • Understanding resource utilisation
    • Profiling code - time, size, etc.
    • Getting system stats
    • Consequences of going over

  • Advanced-jobs.md (doesn't exist yet)

    • Checking status of jobs (squeue, bjobs etc.), explain different job states and relate to scheduler basics
    • Cancelling/deleting a job (scancel, bkill etc.)
    • Passing options to the scheduler (log files)
    • Callout: Changing a job's name
    • Optional Callout: Send an email once the job completes (not all sites support sending emails)
    • for a starting point, see this for reference

  • Filesystem-zoo.md (doesn't exist yet)

    • execute a job that collects node information and stores the output to /tmp
    • ask participants where the output went and why they can't see it
    • execute a job that collects node information and stores the output to /shared or however your shared file system is called
    • for a starting point, see this for reference