Skip to content

Minor style and typo fixes to uenv documentation #131

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 3, 2025
Merged

Minor style and typo fixes to uenv documentation #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/software/uenv/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ uenv build <recipe> <label>
uenv build $SCRATCH/recipes/myapp myapp/v3@daint%gh200
```

The output of the above command will print a url that links to a status page, for you to follow the progress of the build.
After a successful build, the uenv can be pulled using an address from the status page:
The output of the above command will print a URL that links to a status page where you can follow the progress of the build.
After a successful build, the uenv can be pulled using a name from the status page:

```bash
uenv image pull service::myapp/v3:1669479716
Expand Down
2 changes: 1 addition & 1 deletion docs/software/uenv/configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@ The default repo location for downloaded uenv images.
The repo is selected according to the following process:

* if the `--repo` CLI arguement overrides
* else if `color` is set in the config file, use that setting
* else if `repo` is set in the config file, use that setting
* else use the default value of `$SCRATCH/.uenv-images`
16 changes: 8 additions & 8 deletions docs/software/uenv/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Deploying uenv

[](){#ref-uenv-deploy-versions}
## Versioning and Labeling
## Versioning and labeling

Uenv images have a **label** of the following form:

Expand Down Expand Up @@ -57,7 +57,7 @@ The node type (microarchitecture) that the uenv is built for.

## Registries

The following naming scheme is employed in the OCI container artifactory for uenv images:
The following naming scheme is employed in the OCI container registry for uenv images:

```text
namespace/system/uarch/name/version:tag
Expand Down Expand Up @@ -92,11 +92,11 @@ Specific uenv recipes are stored in `recipes/name/version/uarch/`.

The `cluster` is specified when building and deploying the uenv, while the `tag` is specified when deploying the uenv.

## uenv Deployment
## uenv deployment

### Deployment Rules
### Deployment rules

A recipe can be built for deployment on different vClusters, and for multiple targets.
A recipe can be built for deployment on different clusters, and for multiple targets.
For example:

* A multicore recipe could be built for `zen2` or `zen3` nodes
Expand Down Expand Up @@ -154,15 +154,15 @@ uenv image copy build::<SOURCE> deploy::<DESTINATION> # (1)!

1. `<DESTINATION>` must be fully qualified.

!!! example "Deploy Using Image ID"
!!! example "Deploy using image ID"

Deploy a uenv from `build::` using the ID of the image:

```bash
uenv image copy build::d2afc254383cef20 deploy::prgenv-nvfortran/24.11:v1@daint%gh200
```

!!! example "Deploy Using Qualified Name"
!!! example "Deploy using qualified name"

Deploy a uenv using the qualified name:

Expand All @@ -174,7 +174,7 @@ uenv image copy build::<SOURCE> deploy::<DESTINATION> # (1)!

The build image uses the CI/CD pipeline ID as the tag. You will need to choose an appropriate tag.

!!! example "Deploy a uenv from One vCluster to Another"
!!! example "Deploy a uenv from one cluster to another"

You can also deploy a uenv from one vCluster to another.
For example, if the `uenv` for `prgenv-gnu` has been deployed on `daint`,
Expand Down
10 changes: 5 additions & 5 deletions docs/software/uenv/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,14 @@ $ uenv --version

On Alps clusters the most recent version 8.1.0 is installed.

??? warning "out of date uenv version on Eiger and Balfrin"
??? warning "Out of date uenv version on Eiger and Balfrin"

The uenv tool available on Eiger and Balfrin is a different version than the one described below, and some commands will be different to those documented here.

!!! note
This note only applies to the current `eigen.cscs.ch` deployment.

The new [`eigen.alps.cscs.ch`][ref-cluster-eiger] deployment has version 8.1.0 of uenv installed.
The new [`eiger.alps.cscs.ch`][ref-cluster-eiger] deployment has version 8.1.0 of uenv installed.

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

Expand Down Expand Up @@ -98,7 +98,7 @@ The available uenv images are stored in a registry, that can be queried using th
The output above lists all of the uenv that are available on the current system ([Eiger][ref-cluster-eiger] in this case).
The search can be refined by providing a [label][ref-uenv-labels].

??? example "using labels to refine search"
??? example "Using labels to refine search"
```bash
# find all uenv with name prgenv-gnu
uenv image find prgenv-gnu
Expand All @@ -117,7 +117,7 @@ The search can be refined by providing a [label][ref-uenv-labels].
```

!!! info
All uenv commands that take a [label][ref-uenv-labels] as an arguement use the same flexible syntax [label descriptions][ref-uenv-labels-examples].
All uenv commands that take a [label][ref-uenv-labels] as an argument use the same flexible syntax [label descriptions][ref-uenv-labels-examples].

## Downloading uenv

Expand Down Expand Up @@ -527,7 +527,7 @@ echo "unset -f uenv" >> $HOME/.bashrc
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.

[](){#ref-uenv-labels}
## uenv Labels
## uenv labels

Uenv are referred to using **labels**, where a label has the following form

Expand Down