Update tutorials #344
Update tutorials #344
Conversation
Co-authored-by: Ilektra Christidi <[email protected]>
Co-authored-by: Ilektra Christidi <[email protected]>
…alibur-tests into tk/add-cosma-tutorial
|
I think I addressed your comments, thanks for those! This is maybe a bit too much of a lecture notes format. I think I need to go through it and write some more prose |
|
|
||
| ## Configuring ReFrame for HPC systems (Cosma) | ||
| > In ReFrame, all the details of the various interactions of a test with the system environment are handled transparently and are set up in its configuration file. | ||
| - [Configuration](https://reframe-hpc.readthedocs.io/en/v4.5.2/tutorial_basics.html#more-of-hello-world) |
There was a problem hiding this comment.
This list appears as continuous text, probably because it's inside a comment.
tkoskela
force-pushed
the
tk/add-cosma-tutorial
branch
from
1e6ece0 to
e86c207
Compare
tkoskela
force-pushed
the
tk/add-cosma-tutorial
branch
from
437dee6 to
ca9b889
Compare
tkoskela
force-pushed
the
tk/add-cosma-tutorial
branch
from
bd732e6 to
185861f
Compare
tkoskela
force-pushed
the
tk/add-cosma-tutorial
branch
from
0790e3f to
fcc121d
Compare
|
Installation section: Following on from creating the virtual env and cloning /installing the tests. It should be made clear that if the next step installing spack and reframe is done inside the virtual env or outside it. The reason is that when you go to the next page on a new system it says "spack env create --without-view -d /path/to/environment" . However based on the previous instruction spack is installed in the virtual env that the excalibur-tests were put in. Reframe: Running the benchmark cases, it would be expected to have it create all IO in a defined folder, providing the -o MyBenchCasesA only puts a subset of files in there with a default/default/default folder structure. Either clarity should be given directly on this page as to the folders and structure created or point to a Reframe man page if this is a standard structure. This is based me as a first time user of spack and Reframe: Use case that I normally do either for different systems or different configs eg GPUA GPUB on the same system is that what to have all the results in one folder so MyBenchCasesA MyBenchCasesB etc in a portable manner. |
| @@ -0,0 +1,67 @@ | |||
| # Getting Started on HPC systems | |||
|
|
|||
| These tutorials have been ran in in-person workshops on various HPC systems in the UK. It should be possible to run on any of the [supported systems](../systems.md), or to [set up the tools](../setup.md) on a local machine. If you have access to one of the systems we've previously used, this tutorial helps you get set up. Otherwise, please consult the [documentation](../install.md) | |||
There was a problem hiding this comment.
" ran in in-person workshops", change to "have been run at in-person workshops ...
| 2. A command line terminal with an ssh client. Most Linux and Mac systems come with these preinstalled. Please see [Connecting to ARCHER2](https://docs.archer2.ac.uk/user-guide/connecting/#command-line-terminal) for more information and Windows instructions. | ||
|
|
||
| === "ARCHER2" | ||
| To run these tutorials on ARCHER2, you need to [connect to ARCHER2 via ssh](https://docs.archer2.ac.uk/user-guide/connecting/). You will need |
|
|
||
| ### Postprocessing features | ||
|
|
||
| The postprocessing can be performed either on a GUI or a CLI. It takes as input either a single perflog or a path that contains perflogs, and it is driven by a configuration YAML file (more on this later). Its outputs can be csv files of the whole or filtered perflog contents, as well as plots. |
There was a problem hiding this comment.
more on this later. put a link to the section rather
| - Spack installs the `nvidia-nsight-systems` package in the background, including the GUI | ||
| - The paths to the collected profile data, and to the GUI launcher are written into `rfm_job.out` | ||
| - To run the GUI remotely, you need to login with `ssh -X`. It may be slow on a remote system. | ||
| - You can (spack) install the GUI locally to view the data. |
There was a problem hiding this comment.
nsys can be run in nvprof mode to provide CLI output not just the GUI. Maybe useful to include this also ?
| === "Cosma" | ||
|
|
||
| This tutorial is run on the [Cosma](https://cosma.readthedocs.io/en/latest/) supercomputer. | ||
| It should be straightforward to run on a different platform, the requirements are `gcc`, `git` and `python3`. (for the later parts you also need `make`, `autotools`, `cmake` and `spack`). |
There was a problem hiding this comment.
so any version of gcc and python3 ? Else give supported or min,max versions
I've added the ReFrame tutorial and fixed the most obvious formatting issues from hackmd. I've also added separate tutorials for getting started, postprocessing and profiling, based on the materials for CIUK.
There are a few rough edges and some of the Cosma output tabs are missing, but I think I'm mostly happy with the content.
You can preview the website by clicking on the details of the publish action