-
Notifications
You must be signed in to change notification settings - Fork 41
Add netcdf-tools uenv docs #292
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| [](){#ref-uenv-netcdf-tools} | ||
| # netcdf-tools | ||
|
|
||
| The `netcdf-tools` uenv provides a set of CLI tools and GUI tools frequently used in climate and weather workflows. | ||
|
|
||
| The release schedule is not fixed, with new releases when required. | ||
|
|
||
| | version | node types | system | status | | ||
| |--------------------|-------------------|-----------------------------------------|--------| | ||
| | 2025 | zen2, gh200 | daint, eiger, santis, clariden | :white_check_mark: | | ||
| | 2024 | zen2, gh200 | daint, eiger, santis, clariden | **DEPRECATED** | | ||
|
|
||
| !!! warning | ||
| The `netcdf-tools/2024` version uses an old interface that won't load views correctly. | ||
|
|
||
| All users of version `2024` should upgrade to `2025` as soon as possible. | ||
|
|
||
|
|
||
| The packages exposed via the `default` and `modules` views in `netcdf-tools/2025:v1` are: | ||
|
|
||
| * [[email protected]](https://packages.spack.io/package.html?name=cdo) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=cray-mpich) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=eccodes) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=ferret) | ||
| * Only provided in Eiger because its build configuration hard-codes x86 instructions. | ||
| * [[email protected]](https://packages.spack.io/package.html?name=gcc) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=gdal) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=geos) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=hdf5) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=nco) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=ncview) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=netcdf-c) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=netcdf-cxx4) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=netcdf-fortran) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=python) | ||
| * [[email protected]](https://packages.spack.io/package.html?name=udunits) | ||
|
|
||
| ## How to use | ||
|
|
||
| Use the different views to access the software | ||
|
|
||
| === "the `netcdf` view" | ||
|
|
||
| The simplest way to get started is to use the `netcdf` file system view, which automatically loads all of the packages when the uenv is started. | ||
|
|
||
| !!! example "test mpi compilers and python provided by netcdf-tools/2025" | ||
| ```console | ||
| # start using the netcdf view | ||
| $ uenv start --view=netcdf netcdf-tools/2025:v1 | ||
|
|
||
| # the software is available | ||
| $ which cdo | ||
| /user-environment/env/netcdf/bin/cdo | ||
| $ which gdal | ||
| /user-environment/env/netcdf/bin/gdal | ||
| $ gdal --version | ||
| GDAL 3.11.0 "Eganville", released 2025/05/06 | ||
| ``` | ||
|
|
||
| !!! example "run applications directly using uenv run" | ||
| ```console | ||
| # run ncview without having to start a uenv session | ||
| $ uenv run netcdf-tools/2025:v1 --view=netcdf -- ncview | ||
|
|
||
| # create an alias that launches tools in netcdf-tools (add it to bashrc) | ||
| $ alias ncx='uenv run --view=netcdf netcdf-tools/2025:v1 --' | ||
| # then run commands: | ||
| $ ncx ncview | ||
| $ ncx cdo | ||
| ``` | ||
|
|
||
| === "modules" | ||
|
|
||
| The uenv provides modules for all of the software packages, which can be made available by using the `modules` view in | ||
| No modules are loaded when a uenv starts, and have to be loaded individually using `module load`. | ||
|
|
||
| !!! example "starting netcdf-tools and using the provided modules" | ||
| ```console | ||
| $ uenv start netcdf-tools/2025:v1 --view=modules | ||
| $ module avail | ||
| ---------------------------- /user-environment/modules ----------------------------- | ||
| cdo/2.5.2 gdal/3.11.0 ncview/2.1.9 squashfs/4.6.1 | ||
| cray-mpich/8.1.32 geos/3.13.1 netcdf-c/4.9.2 udunits/2.2.28 | ||
| eccodes/2.41.0 hdf5/1.14.6 netcdf-cxx4/4.3.1 | ||
| ferret/7.6.0 libfabric/1.22.0 netcdf-fortran/4.6.1 | ||
| gcc/14.3.0 nco/5.3.3 python/3.13.5 | ||
| $ module load gdal | ||
| $ gdal --version | ||
| GDAL 3.11.0 "Eganville", released 2025/05/06 | ||
| ``` | ||
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
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.
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.
Do we need to just remove this uenv if it's completely broken? Or can it still be used for some things?
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.
It should be removed, I think.