Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update tutorials #344

Merged
merged 35 commits into from
Feb 24, 2025
Merged
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
e5070fc
Rename to archer2 tutorial so we can add others
tkoskela Sep 20, 2024
fd9a277
Add raw markdown from durham tutorial
tkoskela Sep 20, 2024
50466d7
Add reframe tutorial to navigation
tkoskela Sep 20, 2024
402833c
Remove hackmd formatting
tkoskela Sep 20, 2024
83f650e
Update tutorial links
tkoskela Sep 20, 2024
db85a8a
Add some comments
tkoskela Sep 20, 2024
edf276d
Fix headings
tkoskela Sep 20, 2024
e730c23
It's more logical to start with the ReFrame tutorial
tkoskela Sep 20, 2024
7f961b8
Update docs/tutorial/durham_reframe_tutorial.md
tkoskela Sep 23, 2024
8ed358e
Apply suggestions from code review
tkoskela Sep 23, 2024
6cf5053
Address review commits
tkoskela Sep 23, 2024
2362c96
Merge branch 'tk/add-cosma-tutorial' of github.com:ukri-excalibur/exc…
tkoskela Sep 23, 2024
99b2400
Try adding another space
tkoskela Sep 23, 2024
869f8e8
One more space
tkoskela Sep 23, 2024
d669be9
Remove duplicate and add note about platform specific stuff
tkoskela Sep 23, 2024
4ef37cc
Rewrite part on perflogs, add link to excalibur-tests.
tkoskela Sep 23, 2024
0fd3565
Add note on how to run
tkoskela Sep 23, 2024
88a52a1
Merge branch 'main' into tk/add-cosma-tutorial
tkoskela Dec 16, 2024
1b6d738
Test tabs
tkoskela Dec 16, 2024
e86c207
Update with ARCHER2 version
tkoskela Dec 16, 2024
2d939b7
WIP, renders tabs
tkoskela Dec 16, 2024
b02ceab
Update python
tkoskela Dec 16, 2024
ca9b889
Add more verbose text, tabs for system specifics
tkoskela Dec 17, 2024
a84a01d
Rename tutorials with more descriptive names
tkoskela Dec 17, 2024
e9bf04a
Fix warnings
tkoskela Dec 17, 2024
185861f
Fix indentation
tkoskela Dec 17, 2024
ab5ebac
Restructure tutorials
tkoskela Dec 18, 2024
b63883d
Some refactoring of duplicate content
tkoskela Dec 18, 2024
25df451
Add dependency
tkoskela Dec 18, 2024
4775a74
Add profiling tutorial
tkoskela Dec 18, 2024
fcc121d
Add tabs to getting started page
tkoskela Dec 18, 2024
6f43d06
Add tabs to MFA section
tkoskela Dec 18, 2024
78fbeae
Address review comments
tkoskela Jan 31, 2025
ce213f9
Add section on spack cache and local data paths
tkoskela Feb 10, 2025
9a2ed42
Merge branch 'main' into tk/add-cosma-tutorial
tkoskela Feb 11, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Address review comments
  • Loading branch information
tkoskela committed Jan 31, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 78fbeaea7d4be1125ada898e4888b4819e573db9
5 changes: 5 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -92,3 +92,8 @@ _**Note**: if you have already installed spack locally and you want to upgrade t
a newer version, you might first have to clear the cache to avoid conflicts:
`spack clean -m`_

It is recommended to always have the python virtual environment active when working with `excalibur-tests`.
However, it should be noted that since `Spack` is not installed via `pip`, it will be installed outside of the
python virtual environment. Also, keep in mind that the Spack environments that are discussed in the next section
are different and independent of the python virtual environment.

3 changes: 2 additions & 1 deletion docs/setup.md
Original file line number Diff line number Diff line change
@@ -81,7 +81,8 @@ configuration. The numbers you need to watch out for are:

When using Spack as build system, ReFrame needs a [Spack
environment](https://spack.readthedocs.io/en/latest/environments.html) to run
its tests. Follow these steps to create a Spack environment for a new system:
its tests. The Spack environment is separate and independent of the python
virtual environment. Follow these steps to create a Spack environment for a new system:

#### Create the environment
```sh
8 changes: 5 additions & 3 deletions docs/tutorial/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# 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)
These tutorials have been run 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)

## Connecting

=== "Cosma"

To run these tutorials on Cosma, you need to [connect to Cosma via ssh](https://cosma.readthedocs.io/en/latest/ssh.html). You will need
To run these tutorials on Cosma, you will need to [connect to Cosma via ssh](https://cosma.readthedocs.io/en/latest/ssh.html). You will need

1. A Cosma account. You can [request a new account](https://cosma.readthedocs.io/en/latest/account.html) if you haven't got one you can use. You can use an existing Cosma account to complete the tutorials.
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
To run these tutorials on ARCHER2, you will need to [connect to ARCHER2 via ssh](https://docs.archer2.ac.uk/user-guide/connecting/). You will need

1. An ARCHER2 account. You can [request a new account](https://docs.archer2.ac.uk/quick-start/quickstart-users/#request-an-account-on-archer2) if you haven't got one you can use. You can use an existing ARCHER2 account to complete the tutorials.
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.
3 changes: 2 additions & 1 deletion docs/tutorial/postprocessing_tutorial.md
Original file line number Diff line number Diff line change
@@ -8,7 +8,8 @@ Now let's browse the benchmark performance results, and create plots to visualis

### 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.
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.

![Screenshot from 2024-04-25 17-01-41](https://hackmd.io/_uploads/HkWxlWOZ0.png)

3 changes: 2 additions & 1 deletion docs/tutorial/setup-python.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
=== "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`).
It should be straightforward to run on a different platform, the requirements are `gcc 4.5`, `git 2.39` and `python 3.7` or later.
(for the later parts you also need `make`, `autotools`, `cmake` and `spack` but these can be installed locally).
Before proceeding to install ReFrame, we recommend creating a python virtual environment to avoid clashes with other installed python packages.
First load a newer python module.
```bash
7 changes: 7 additions & 0 deletions docs/use.md
Original file line number Diff line number Diff line change
@@ -75,6 +75,13 @@ reframe -c benchmarks/apps/sombrero -r --performance-report -S env_vars=OMP_PLAC
runs the `benchmarks/apps/sombrero` benchmark setting the environment variable `OMP_PLACES`
to `threads`.

### Output directories

By default `reframe` creates three output directories (`stage`, `output` and `perflogs`) in the directory
where it is run. Output can be written to a different base directory using the [`--prefix` command-line option](https://reframe-hpc.readthedocs.io/en/stable/manpage.html#cmdoption-prefix).

The individual output directories can also be changed using the `--stage`, `--outputdir` and `--perflogdir` options.

## Usage on unsupported systems

The configuration provided in [`reframe_config.py`](https://github.com/ukri-excalibur/excalibur-tests/blob/main/benchmarks/reframe_config.py) lets you run the
Loading