Intro to HPC
This lesson is focused on teaching the basics of high-performance computing (HPC).
Lesson writing instructions
This is a fast overview of the Software Carpentry lesson template. This won't cover lesson style or formatting (address that during review?).
For a full guide to the lesson template, see the Software Carpentry example lesson.
Software Carpentry lessons are generally episodic, with one clear concept for each episode (example). We've got 4 major sections, each section should be broken up into several episodes (perhaps the higher-level bullet points from the lesson outline?).
An episode is just a markdown file that lives under the
Here is a link to a markdown cheatsheet with most markdown syntax.
Additionally, the Software Carpentry lesson template uses several extra bits of formatting- see here for a full guide.
The most significant change is the addition of a YAML header that adds metadata (key questions, lesson teaching times, etc.)
and special syntax for code blocks, exercises, and the like.
Episode names should be prefixed with a number of their section plus the number of their episode within that section. This is important because the Software Carpentry lesson template will auto-post our lessons in the order that they would sort in. As long as your lesson sorts into the correct order, it will appear in the correct order on the website.
Publishing changes to Github + the Github pages website
The lesson website is viewable at https://hpc-carpentry.github.io/hpc-intro/
The lesson website itself is auto-generated from the
gh-pages branch of this repository.
Github pages will rebuild the website as soon as you push to the Github
Because of this
gh-pages is considered the "master" branch.
Previewing changes locally
Obviously having to push to Github every time you want to view your changes to the website isn't very convenient.
To preview the lesson locally, run
You can then view the website at
localhost:4000 in your browser.
Pages will be automatically regenerated every time you write to them.
Note that the autogenerated website lives under the
(and doesn't get pushed to Github).
This process requires Ruby, Make, and Jekyll. You can find setup instructions here.
A couple links to example SWC workshop lessons for reference: