Skip to content

Commit

Permalink
Add episodes
Browse files Browse the repository at this point in the history
  • Loading branch information
jsteyn committed Oct 18, 2024
1 parent 576d1cc commit 5a96bd3
Show file tree
Hide file tree
Showing 9 changed files with 171 additions and 33 deletions.
19 changes: 11 additions & 8 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,32 @@
carpentry: 'incubator'

# Alt-text description of the lesson.
carpentry_description: 'A step-by-step, hands-on lesson for using laptops, single board computers or whatever is lying around to build an HPC that can be used for training and prototyping.'
carpentry_description: 'A step-by-step, hands-on lesson for using Raspberry Pi single board computers to build an HPC that can be used for training and prototyping.'

# Overall title for pages.
title: 'Building an HPC for Training' # FIXME
title: 'Building an HPC for Training'

# Date the lesson was created (YYYY-MM-DD, this is empty by default)
created: ~ # 2024-10-15

# Comma-separated list of keywords for the lesson
keywords: 'software, data, lesson, The Carpentries' # FIXME
keywords: 'software, data, lesson, The Carpentries, Raspberry Pi, HPC'

# Life cycle stage of the lesson
# possible values: pre-alpha, alpha, beta, stable
life_cycle: 'pre-alpha' # FIXME
life_cycle: 'pre-alpha' #

# License of the lesson
license: 'CC-BY 4.0'

# Link to the source repository for this lesson
source: 'https://github.com/carpentries/workbench-template-md' # FIXME
source: 'https://github.com/carpentriesoffline/Building_an_HPC_for_Training'

# Default branch of your lesson
branch: 'main'

# Who to contact if there are any issues
contact: '[email protected]' # FIXME
contact: '[email protected]'

# Navigation ------------------------------------------------
#
Expand Down Expand Up @@ -68,6 +68,11 @@ contact: '[email protected]' # FIXME
episodes:
- 01-intro.md
- 02-prepareSDCard.md
- 03-booting_and_updating.md
- 04-installing_eessi.md
- 05-working_with_modules.md
- 06-installing_pxe.md
- 07-installing_scheduler.md

# Information for Learners
learners:
Expand All @@ -82,5 +87,3 @@ profiles:
#
# This space below is where custom yaml items (e.g. pinning
# sandpaper and varnish versions) should live


27 changes: 13 additions & 14 deletions episodes/02-prepareSDCard.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,22 +51,21 @@ provide pre-prepared microSD cards.

::: challenge
## Challenge 1: What software do you need to prepare an SD card?
1. Word 2. Excel 3. Raspberry Pi Imager 4. LibreOffice 5. SonicPi
1. Word
2. Excel
3. Raspberry Pi Imager
4. LibreOffice
5. SonicPi

:::::: solution
1. Word cannot be used to prepare an SD card, it is a word processor 3. Excel
cannot be used to prepare an SD card, it is a spreadsheet 4. The correct answer
is *3* 5. LibreOffice is an office suite and connot be used to prepare an SD
card 6. SonicPi is a live coding environment to support computing and music
1. Word cannot be used to prepare an SD card, it is a word processor
2. Excel cannot be used to prepare an SD card, it is a spreadsheet
3. The correct answer is *3*
5. LibreOffice is an office suite and connot be used to prepare an SD
card
6. SonicPi is a live coding environment to support computing and music
lessons in schools.

::::::
:::
::: challenge
## Challenge 2: Where would you find the CarpentriesOffline image?
1. On the Raspberry Pi website 2. On The Carpentries website 3. On the
CarpentriesOffline website 4. On the Microsoft website?
:::::: solution
::::::
:::

Expand All @@ -84,13 +83,13 @@ Raspberry Pi Imager software intro screen'}

You can now click on the **Choose OS** button which will open a window for
selecting the image you want to write to the SD card. Scroll down to the bottom
where you should find an option **Use custom**. Click on that option:
where you should find an option **Raspberry Pi OS (other)**. Click on that option:

![Selecting an image to write to the SD card](fig/ChooseImage.png){alt='An image
of the RPi Imager software screen for selecting an image to be written to the SD
card'}

Navigate to where you saved the CarpentriesOffline image and select it. Make
Select **Raspberry Pi OS Lite (64 bit)**. Make
sure you have inserted the SD card into your computer. Now click on the **Choose
Storage** button and select the device you want to write the image to:

Expand Down
29 changes: 29 additions & 0 deletions episodes/03-booting_and_updating.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Booting and Updating"
teaching: 10
exercises: 0
---

:::::::::::::::::::::::::::::::::::::: questions

- Questions to ask

::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: objectives

- Objectives

::::::::::::::::::::::::::::::::::::::::::::::::

## Text

Some text.

::::::::::::::::::::::::::::::::::::: keypoints

- What have we learnt?

::::::::::::::::::::::::::::::::::::::::::::::::

[r-markdown]: https://rmarkdown.rstudio.com/
29 changes: 29 additions & 0 deletions episodes/04-installing_eessi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "An episode"
teaching: 10
exercises: 0
---

:::::::::::::::::::::::::::::::::::::: questions

- Questions to ask

::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: objectives

- Objectives

::::::::::::::::::::::::::::::::::::::::::::::::

## Text

Some text.

::::::::::::::::::::::::::::::::::::: keypoints

- What have we learnt?

::::::::::::::::::::::::::::::::::::::::::::::::

[r-markdown]: https://rmarkdown.rstudio.com/
29 changes: 29 additions & 0 deletions episodes/05-working_with_modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "An episode"
teaching: 10
exercises: 0
---

:::::::::::::::::::::::::::::::::::::: questions

- Questions to ask

::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: objectives

- Objectives

::::::::::::::::::::::::::::::::::::::::::::::::

## Text

Some text.

::::::::::::::::::::::::::::::::::::: keypoints

- What have we learnt?

::::::::::::::::::::::::::::::::::::::::::::::::

[r-markdown]: https://rmarkdown.rstudio.com/
29 changes: 29 additions & 0 deletions episodes/06-installing_pxe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "An episode"
teaching: 10
exercises: 0
---

:::::::::::::::::::::::::::::::::::::: questions

- Questions to ask

::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: objectives

- Objectives

::::::::::::::::::::::::::::::::::::::::::::::::

## Text

Some text.

::::::::::::::::::::::::::::::::::::: keypoints

- What have we learnt?

::::::::::::::::::::::::::::::::::::::::::::::::

[r-markdown]: https://rmarkdown.rstudio.com/
29 changes: 29 additions & 0 deletions episodes/07-installing_scheduler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "An episode"
teaching: 10
exercises: 0
---

:::::::::::::::::::::::::::::::::::::: questions

- Questions to ask

::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: objectives

- Objectives

::::::::::::::::::::::::::::::::::::::::::::::::

## Text

Some text.

::::::::::::::::::::::::::::::::::::: keypoints

- What have we learnt?

::::::::::::::::::::::::::::::::::::::::::::::::

[r-markdown]: https://rmarkdown.rstudio.com/
Binary file modified episodes/fig/ChooseImage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 2 additions & 11 deletions learners/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Setup

The minimum equipment you will need for this lesson would be:

- 2 computers (eg. two Raspberry Pis or laptops), one which will serve as the
- 2 Raspberry Pis, one which will serve as the
login node and one which will be a compute node. These do not need keyboards
and screens but it is sometimes handy to have a keyboard and screen for when
you run into trouble.
Expand All @@ -15,19 +15,10 @@ useful for this workstation to have an ethernet port.
- If your switch has Power over Ethernet (PoE) you might not need power supplies
for your two node. If they don't, don't forget the power supplies. Also don't
forget the power supply for the switch itself.
- You'll need at least one SD card if you are using Raspberry Pis or any other
single board computer (SBC). It might be helpful if you have two in case PXE
- You'll need at least one SD card. It might be helpful if you have two in case PXE
(Preboot eXecution Environment) doesn't want to work.


## Data Sets

<!--
FIXME: place any data you want learners to use in `episodes/data` and then use
a relative link ( [data zip file](data/lesson-data.zip) ) to provide a
link to it, replacing the example.com link.
-->
Download the [data zip file](https://example.com/FIXME) and unzip it to your Desktop

## Software Setup

Expand Down

0 comments on commit 5a96bd3

Please sign in to comment.