uenv 8.1 docs #125
Merged
uenv 8.1 docs #125
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
preview available: https://docs.tds.cscs.ch/125 |
|
preview available: https://docs.tds.cscs.ch/125 |
RMeli
reviewed
Jun 3, 2025
|
preview available: https://docs.tds.cscs.ch/125 |
|
preview available: https://docs.tds.cscs.ch/125 |
RMeli
approved these changes
Jun 3, 2025
|
preview available: https://docs.tds.cscs.ch/125 |
msimberg
requested changes
Jun 3, 2025
Collaborator
msimberg
left a comment
msimberg
left a comment
There was a problem hiding this comment.
I was too slow. I'll open a PR with the small suggestions.
| 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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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. |
?
| ``` | ||
|
|
||
| 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: |
Collaborator
There was a problem hiding this comment.
Suggested change
| After a successful build, the uenv can be pulled using an address from the status page: | |
| After a successful build, the uenv can be pulled using a name from the status page: |
?
| | key | description | default | values | | ||
| | --- | ----------- | -------- | ------ | | ||
| | [`color`][ref-uenv-configure-options-color] | Use color output | automatically chosen according to environment | `true`, `false` | | ||
| | [`repo`][ref-uenv-configure-options-repo] | The default repo location for downloaded uenv images | `$SCRATCH/.uenv-images` | An absolute path | |
Collaborator
There was a problem hiding this comment.
Is it worth mentioning here that $SCRATCH/.uenv-images is exempt from the cleanup policy? Putting it in another directory in scratch may lead to surprising issues with the uenv database if images are deleted, no?
| 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 |
Collaborator
There was a problem hiding this comment.
Suggested change
| * else if `color` is set in the config file, use that setting | |
| * else if `repo` is set in the config file, use that setting |
| # Deploying uenv | ||
|
|
||
| [](){#ref-uenv-deploy-versions} | ||
| ## Versioning and Labeling |
Collaborator
There was a problem hiding this comment.
Suggested change
| ## Versioning and Labeling | |
| ## Versioning and labeling |
|
|
||
| # this can be used to search for all uenv on daint: | ||
| uenv image find @daint | ||
| The new [`eigen.alps.cscs.ch`][ref-cluster-eiger] deployment has version 8.1.0 of uenv installed. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 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. |
| 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" |
Collaborator
There was a problem hiding this comment.
Suggested change
| ??? example "using labels to refine search" | |
| ??? example "Using labels to refine search" |
| ``` | ||
|
|
||
| !!! 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]. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 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]. |
| 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 |
Collaborator
There was a problem hiding this comment.
Suggested change
| ## uenv Labels | |
| ## uenv labels |
Comment on lines
+529
to
+530
| [](){#ref-uenv-labels} | ||
| ## uenv Labels |
Collaborator
There was a problem hiding this comment.
There's some overlap between this description of labels and the one in deploy.md. Can deploy.md link to here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refactor uenv docs.