-
Notifications
You must be signed in to change notification settings - Fork 19
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
base: main
Are you sure you want to change the base?
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This list appears as continuous text, probably because it's inside a comment.
1e6ece0
to
e86c207
Compare
437dee6
to
ca9b889
Compare
bd732e6
to
185861f
Compare
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. |
|
||
### 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
more on this later. put a link to the section rather
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a link to the documentation in the section above this one
- 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nsys can be run in nvprof mode to provide CLI output not just the GUI. Maybe useful to include this also ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I created #358 for this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added comments on a first glace read. Will do an actual run in the coming days.
c378e3c
to
edee911
Compare
edee911
to
78fbeae
Compare
I added more detail on this in the installation and setup sections of the documentation. Is it clear now?
Upon reading a bit of ReFrame documentation I found the flag that does this. It is |
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