Skip to content

Commit 25a3772

Browse files
committed
update for hpc-parallel-novice
1 parent 7da0037 commit 25a3772

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
1-
# HPC-in-a-day [![DOI](https://zenodo.org/badge/83803821.svg)](https://zenodo.org/badge/latestdoi/83803821)
1+
# Introduction to Parallelisation on HPC platforms
22

3-
Novice introduction to high performance computing. This material was conceived as a sandbox project for [swcarpentry/hpc-novice](https://github.com/psteinb/hpc-in-a-day). Parts of it will be contributed to [swcarpentry/hpc-novice](https://github.com/psteinb/hpc-in-a-day) in due course.
3+
Novice introduction to parallelisation with high performance computing. This material was conceived as a sandbox project for [hpc-carpentry](https://hpc-carpentry.org). This work derives from [hpc-in-a-day](https://github.com/psteinb/hpc-in-a-day) but will not be kept in sync.
44

55
## Material
66

7-
The material can be viewed [here](https://psteinb.github.io/hpc-in-a-day)!
7+
The material can be viewed [here](https://psteinb.github.io/hpc-parallel-novice)!
88

99
## Audience
1010

11-
The material as such targets future users of a HPC infrastructure of any discipline. The learners are expected to have an introductory level of programming skills and should know their way around the UNIX command line on a beginners level as well.
11+
The material targets future users of a HPC infrastructure of any discipline. The learners are expected to have an introductory level of programming skills. Learners are expected to know how to submit a batch job on a HPC cluster. Further, knowledge on how to write functions in python are required. Basic `numpy` array commands are beneficial but not required to follow the course.
1212

1313
## Scheduler
1414

15-
hpc-in-a-day is scheduler agnostic. Currently, it supports LSF and SLURM. The job scheduler type can be set with the `workshop_scheduler` variable in [_config.yaml](https://github.com/psteinb/hpc-in-a-day/blob/711cf3f309a04d4a6e955e39c701444733194fed/_config.yml#L40).
15+
This material tries to be scheduler agnostic. Currently, it supports LSF and SLURM. The job scheduler type can be set with the `workshop_scheduler` variable in [_config.yaml](./_config.yaml).
1616

1717
# How to build
1818

1919
## Dependencies
2020

2121
The material is based on the [software carpentry lesson template](https://github.com/swcarpentry/styles). It hence depends on a fairly recent version of [jekyll](jekyllrb.org). Just give building it with `make site` in the root directory a try. If you find any problems, please open an issue.
22+
23+
## local tests
24+
25+
To test the material locally, open a terminal and type:
26+
27+
```
28+
$ make serve
29+
# ...
30+
Server address: http://127.0.0.1:4000
31+
Server running... press ctrl-c to stop.
32+
```
33+
34+
Once you see the above, open a web browser on the same machine and copy \& paste `http://127.0.0.1:4000` in the URL address field. Load this page and you should see a local version of the material display. Exit the rendering as prompted by pressing `ctrl-c`.

0 commit comments

Comments
 (0)