Skip to content

Commit 8542447

Browse files
committed
clean up main uenv page
1 parent 843b50e commit 8542447

File tree

1 file changed

+31
-9
lines changed

1 file changed

+31
-9
lines changed

docs/software/uenv/index.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ On Alps clusters the most recent version 8.1.0 is installed.
6363

6464
Please refer to `uenv --help` for the correct usage on these systems.
6565

66-
6766
## Finding uenv
6867

6968
Uenv for programming environments, tools and applications are provided by CSCS on each Alps system.
@@ -96,13 +95,34 @@ The available uenv images are stored in a registry, that can be queried using th
9695
quantumespresso/v7.3.1:v1 zen2 eiger 61d1f21881a65578 864 2024-11-08
9796
```
9897

99-
The output above shows that there are 12 uenv (`prgenv-gnu`, `namd` , `cp2k` and `arbor`).
98+
The output above lists all of the uenv that are available on the current system ([Eiger][ref-cluster-eiger] in this case).
99+
The search can be refined by providing a [label][ref-uenv-labels].
100+
101+
??? example "using labels to refine search"
102+
```bash
103+
# find all uenv with name prgenv-gnu
104+
uenv image find prgenv-gnu
105+
106+
# find all uenv with name and version prgenv-gnu/24.11
107+
uenv image find prgenv-gnu/24.11
108+
109+
# find all uenv available for daint
110+
uenv image find @daint
111+
112+
# find all prgenv-gnu uenv available on a cluster
113+
uenv image find prgenv-gnu@daint
114+
115+
# find all uenv in the service namespace with name myenv
116+
uenv image find service::myenv
117+
```
118+
119+
!!! info
120+
All uenv commands that take a [label][ref-uenv-labels] as an arguement use the same flexible syntax [label descriptions][ref-uenv-labels-examples].
100121

101122
## Downloading uenv
102123

103-
!!! note
104-
In order to pull uenv images, a local directory for storing the images must first be created,
105-
otherwise you will receive an error message that the repository does not exist.
124+
??? note "Using uenv for the first time on Balfrin and Eiger"
125+
With the old version of uenv installed on Balfrin and Eiger, before downloading your first image, a local directory for storing the images must first be created, otherwise you will receive an error message that the repository does not exist.
106126

107127
To create a repo in the default location, use the following command:
108128

@@ -163,7 +183,7 @@ Tokens are created by CSCS, and stored on SCRATCH in a file that only users who
163183
```
164184

165185
!!! note
166-
As of March 2025, the only restricted software is VASP.
186+
As of June 2025, the only restricted software is VASP.
167187

168188
!!! note
169189
Better token management is under development - tokens will be stored in a central location and will be easier to use.
@@ -224,12 +244,12 @@ This is very useful for interactive sessions, for example if you want to work in
224244
SHELL=`which zsh` uenv start ...
225245
```
226246

227-
!!! warning "C Shell / tcsh users"
247+
??? warning "C Shell / tcsh users"
228248
uenv is tested extensively with bash (the default shell), and zsh. C shell is not tested properly, and we will not make significant changes to uenv to maintain support for C shell.
229249

230250
If your are one of the handful of users using `tcsh` (C shell) and you want to use uenv, we strongly recommend creating a request at the [CSCS service desk](https://jira.cscs.ch/plugins/servlet/desk) to change to either bash or zsh as your default.
231251

232-
!!! warning "Failed to unshare the mount namespace"
252+
??? warning "Failed to unshare the mount namespace"
233253

234254
If you get the following error message when starting a uenv:
235255
```console
@@ -506,6 +526,7 @@ echo "unset -f uenv" >> $HOME/.bashrc
506526
!!! warning
507527
Before uenv can be used, you need to log out then back in again and type `which uenv` to verify that uenv has been installed in your `$HOME` path.
508528

529+
[](){#ref-uenv-labels}
509530
## uenv Labels
510531

511532
Uenv are referred to using **labels**, where a label has the following form
@@ -524,7 +545,7 @@ The different fields are described in the following table:
524545
| `version` | version of the uenv: e.g. `v8.7`, `2025.01` |
525546
| `tag` | a tag applied by CSCS |
526547

527-
!!! example
548+
!!! example "Example labels"
528549
??? note "`prgenv-gnu/24.11:v2@daint%gh200`"
529550
The `prgenv-gnu` programming environment, built on [Daint][ref-cluster-daint] for the Grace-Hopper GH200 (`gh200`) architecture.
530551

@@ -539,6 +560,7 @@ The different fields are described in the following table:
539560

540561
For more information about the labeling scheme, see the [uenv deployment][ref-uenv-deploy-versions] docs.
541562

563+
[](){#ref-uenv-labels-examples}
542564
### Using labels
543565

544566
The uenv command line has a flexible interface for filtering uenv by providing only part of the full label:

0 commit comments

Comments
 (0)