Skip to content

Commit ce5f6d2

Browse files
bcummingbcumming
committed
merge main
2 parents 3ec1a01 + c85918c commit ce5f6d2

File tree

7 files changed

+124
-22
lines changed

7 files changed

+124
-22
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing
2+
3+
Please take some time to get familiar with the [contributing guidelines](https://docs.cscs.ch/contributing/) before making your first contribution.

‎.github/actions/spelling/allow.txt‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ Scopi
106106
Signalkuppe
107107
TOTP
108108
UANs
109+
UIs
109110
UserLab
110111
Wannier
111112
XDG
@@ -212,6 +213,7 @@ netlib
212213
netrc
213214
nql
214215
nsight
216+
nsys
215217
numa
216218
nvcr
217219
nvdashboard
@@ -341,6 +343,7 @@ wikipedia
341343
wikitext
342344
wlcg
343345
workaround
346+
workarounds
344347
workflows
345348
wrf
346349
xattr
@@ -357,4 +360,4 @@ jobscript
357360
Scalasca
358361
tracefile
359362
Vampir
360-
XAmz
363+
XAmz

‎.github/workflows/welcome.yaml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: First interaction message
2+
3+
on:
4+
pull_request_target:
5+
types: [opened]
6+
branches:
7+
- main
8+
9+
jobs:
10+
greeting:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
pull-requests: write
14+
steps:
15+
- uses: actions/first-interaction@v3
16+
with:
17+
pr-message: |
18+
Thank you for your contribution to eth-cscs/cscs-docs.
19+
20+
If you have not done so already, please take some time to get familiar with the [contributing guidelines](https://docs.cscs.ch/contributing/).
21+
Following the guidelines helps us keep the documentation consistent and as useful as possible for users.

‎docs/access/jupyterlab.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ If the default base images do not meet your requirements, you can specify a cust
8383

8484
1. Avoid mounting all of `$HOME` to avoid subtle issues with cached files, but mount Jupyter kernels
8585
2. Enable Slurm commands (together with two subsequent mounts)
86-
3. Currently only required on Daint and Santis, not on Clariden
86+
3. Required only for Daint and Santis; Do not use on Clariden
8787
4. Set working directory of Jupyter session (file browser root directory)
8888
5. Use environment settings for optimized communication
8989
6. Avoid writing JITed binaries to the (distributed) file system, which could lead to performance issues.

‎docs/contributing/index.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -489,6 +489,32 @@ If you want to display commands without output that can easily be copied, use `b
489489
echo "Hello, world!"
490490
```
491491

492+
### Avoiding repetition using snippets
493+
494+
It can be useful to repeat information on different pages to increase visibility for users.
495+
If possible, prefer linking to a primary section describing a topic instead of fully repeating text on different pages.
496+
However, if you believe it's beneficial to actually repeat the content, consider using [snippets](https://facelessuser.github.io/pymdown-extensions/extensions/snippets/) to avoid repeated information getting out of sync on different pages.
497+
Snippets allow including the contents of a text file in multiple places of the documentation.
498+
499+
For example, the recommended NCCL environment variables are defined in a text file [`docs/software/commuinication/nccl_env_vars`](https://github.com/eth-cscs/cscs-docs/blob/main/docs/software/communication/nccl_env_vars) and included on multiple pages because it's essential that users of NCCL notice and use the environment variables.
500+
501+
Snippets are included with `--8<-- path/to/snippet`.
502+
For example, to include the recommended NCCL environment variables, do the following:
503+
504+
=== "Markdown"
505+
506+
````markdown
507+
```bash
508+
;--8<-- "docs/software/communication/nccl_env_vars"
509+
```
510+
````
511+
512+
=== "Rendered"
513+
514+
```bash title="Recommended NCCL environment variables"
515+
--8<-- "docs/software/communication/nccl_env_vars"
516+
```
517+
492518
## Documentation structure
493519

494520
Here we describe a high-level overview of the documentation layout and organisation.

‎docs/software/devtools/nvidia-nsight.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ As a sampling profiler, it can be easily used to profile applications written in
2626
### Known Issues and Common Problems
2727

2828
??? warning "CrashReporter: Qt initialization failed, Failed to load Qt platform plugin: xcb"
29+
!!! info "This workaround is not needed for uenvs that provide `xcb-util-cursor`"
30+
Uenvs that provide the `xcb-util-cursor` package don't require this workaround anymore.
31+
Starting with 25.6, the [`prgenv-gnu`][ref-uenv-prgenv-gnu] provides `xcb-util-cursor`.
32+
2933
While we recommend using `ncu` instead of `ncu-ui`, it is possible to use X11 to launch ncu-ui.
3034
However, this will fail with the following error message: `Failed to load Qt platform plugin: "xcb"`.
3135

‎docs/software/prgenv/prgenv-gnu.md‎

Lines changed: 65 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The release schedule is not fixed, with new versions will be released roughly ev
1919

2020
| version | node types | system |
2121
|--------------------|-------------------|-----------------------------------------|
22-
| 25.06 (prerelease) | gh200 | daint |
22+
| 25.6 | gh200 | daint, eiger, santis, clariden |
2323
| 24.11 | a100, gh200, zen2 | daint, eiger, santis, clariden, bristen |
2424
| 24.7 | gh200, zen2 | daint, eiger, todi |
2525

@@ -32,6 +32,49 @@ We will provide full support for 12 months after the uenv image is released, and
3232

3333
### Versions
3434

35+
=== "25.6"
36+
37+
The key updates in version 25.6 compared to 24.11 are:
38+
39+
* upgrading GCC to version 14 and CUDA to version 12.9
40+
* upgrading cray-mpich to version 8.1.32
41+
* adding xcb-util-cursor to the default view to allow the [NVIDIA Nsight UIs][ref-devtools-nsight] to be used without manual workarounds
42+
43+
The spack version used to build the packages was also upgraded to 1.0.
44+
45+
??? info "all packages exposed via the `default` and `modules` views in `v1`"
46+
* [[email protected]](https://packages.spack.io/package.html?name=aws-ofi-nccl)
47+
* [[email protected]](https://packages.spack.io/package.html?name=boost)
48+
* [[email protected]](https://packages.spack.io/package.html?name=cmake)
49+
* [[email protected]](https://packages.spack.io/package.html?name=cray-mpich)
50+
* [[email protected]](https://packages.spack.io/package.html?name=cuda)
51+
* [[email protected]](https://packages.spack.io/package.html?name=fftw)
52+
* [[email protected]](https://packages.spack.io/package.html?name=fmt)
53+
* [[email protected]](https://packages.spack.io/package.html?name=gcc)
54+
* [[email protected]](https://packages.spack.io/package.html?name=gsl)
55+
* [[email protected]](https://packages.spack.io/package.html?name=hdf5)
56+
* [[email protected]](https://packages.spack.io/package.html?name=kokkos)
57+
* [[email protected]](https://packages.spack.io/package.html?name=kokkos-kernels)
58+
* [kokkos-tools@develop](https://packages.spack.io/package.html?name=kokkos-tools)
59+
* [[email protected]](https://packages.spack.io/package.html?name=libtree)
60+
* [[email protected]](https://packages.spack.io/package.html?name=lua)
61+
* [[email protected]](https://packages.spack.io/package.html?name=lz4)
62+
* [[email protected]](https://packages.spack.io/package.html?name=meson)
63+
* [[email protected]](https://packages.spack.io/package.html?name=nccl)
64+
* [[email protected]](https://packages.spack.io/package.html?name=nccl-tests)
65+
* [[email protected]](https://packages.spack.io/package.html?name=netcdf-c)
66+
* [[email protected]](https://packages.spack.io/package.html?name=netcdf-cxx)
67+
* [[email protected]](https://packages.spack.io/package.html?name=netcdf-fortran)
68+
* [[email protected]](https://packages.spack.io/package.html?name=netlib-scalapack)
69+
* [[email protected]](https://packages.spack.io/package.html?name=ninja)
70+
* [[email protected]](https://packages.spack.io/package.html?name=openblas)
71+
* [[email protected]](https://packages.spack.io/package.html?name=osu-micro-benchmarks)
72+
* [[email protected]](https://packages.spack.io/package.html?name=papi)
73+
* [[email protected]](https://packages.spack.io/package.html?name=python)
74+
* [[email protected]](https://packages.spack.io/package.html?name=superlu)
75+
* [[email protected]](https://packages.spack.io/package.html?name=xcb-util-cursor)
76+
* [[email protected]](https://packages.spack.io/package.html?name=zlib-ng)
77+
3578
=== "24.11"
3679

3780
The key updates in version 24.11:v1 from the 24.7 version were:
@@ -112,21 +155,21 @@ There are three ways to access the software provided by prgenv-gnu, once it has
112155
!!! example "test mpi compilers and python provided by prgenv-gnu/24.11"
113156
```console
114157
# start using the default view
115-
$ uenv start --view=default prgenv-gnu/24.11:v1
158+
$ uenv start --view=default prgenv-gnu/25.6:v1
116159

117160
# the python executable provided by the uenv is the default, and is a recent version
118161
$ which python
119162
/user-environment/env/default/bin/python
120163
$ python --version
121-
Python 3.12.5
164+
Python 3.13.5
122165

123166
# the mpi compiler wrappers are also available
124167
$ which mpicc
125168
/user-environment/env/default/bin/mpicc
126169
$ mpicc --version
127-
gcc (Spack GCC) 13.3.0
170+
gcc (Spack GCC) 14.2.0
128171
$ gcc --version # the compiler wrapper uses the gcc provided by the uenv
129-
gcc (Spack GCC) 13.3.0
172+
gcc (Spack GCC) 14.2.0
130173
```
131174

132175
=== "modules"
@@ -136,23 +179,25 @@ There are three ways to access the software provided by prgenv-gnu, once it has
136179

137180
!!! example "starting prgenv-gnu and listing the provided modules"
138181
```console
139-
$ uenv start prgenv-gnu/24.11:v1 --view=modules
182+
$ uenv start prgenv-gnu/25.6:v1 --view=modules
140183
$ module avail
141184
---------------------------- /user-environment/modules ----------------------------
142-
aws-ofi-nccl/git.v1.9.2-aws_1.9.2 lua/5.4.6
143-
boost/1.86.0 lz4/1.10.0
144-
cmake/3.30.5 meson/1.5.1
145-
cray-mpich/8.1.30 nccl-tests/2.13.6
146-
cuda/12.6.2 nccl/2.22.3-1
147-
fftw/3.3.10 netlib-scalapack/2.2.0
148-
fmt/11.0.2 ninja/1.12.1
149-
gcc/13.3.0 openblas/0.3.28
150-
gsl/2.8 osu-micro-benchmarks/5.9
151-
hdf5/1.14.5 papi/7.1.0
152-
kokkos-kernels/4.4.01 python/3.12.5
153-
kokkos-tools/develop superlu/5.3.0
154-
kokkos/4.4.01 zlib-ng/2.2.1
155-
libtree/3.1.1
185+
aws-ofi-nccl/1.16.0 meson/1.7.0
186+
boost/1.88.0 nccl-tests/2.16.3
187+
cmake/3.31.8 nccl/2.27.5-1
188+
cray-mpich/8.1.32 netcdf-c/4.9.2
189+
cuda/12.9.0 netcdf-cxx/4.2
190+
fftw/3.3.10 netcdf-fortran/4.6.1
191+
fmt/11.2.0 netlib-scalapack/2.2.2
192+
gsl/2.8 ninja/1.12.1
193+
hdf5/1.14.6 openblas/0.3.29
194+
kokkos-kernels/4.6.01 osu-micro-benchmarks/7.5
195+
kokkos-tools/develop papi/7.1.0
196+
kokkos/4.6.01 python/3.13.5
197+
libfabric/1.22.0 squashfs/4.6.1
198+
libtree/3.1.1 superlu/7.0.0
199+
lua/5.4.6 xcb-util-cursor/0.1.5
200+
lz4/1.10.0 zlib-ng/2.2.4
156201
```
157202

158203
=== "Spack"

0 commit comments

Comments
 (0)