Skip to content

Commit f308078

Browse files
authored
Add netcdf-tools uenv docs (#292)
There were no netcdf-tools docs. Add them to go with the release of netcdf-tools/2025 https://docs.tds.cscs.ch/292/software/cw/netcdf-tools/
1 parent 61e554b commit f308078

File tree

2 files changed

+91
-0
lines changed

2 files changed

+91
-0
lines changed

docs/software/cw/netcdf-tools.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
[](){#ref-uenv-netcdf-tools}
2+
# netcdf-tools
3+
4+
The `netcdf-tools` uenv provides a set of CLI tools and GUI tools frequently used in climate and weather workflows.
5+
6+
The release schedule is not fixed, with new releases when required.
7+
8+
| version | node types | system | status |
9+
|--------------------|-------------------|-----------------------------------------|--------|
10+
| 2025 | zen2, gh200 | daint, eiger, santis, clariden | :white_check_mark: |
11+
| 2024 | zen2, gh200 | daint, eiger, santis, clariden | **DEPRECATED** |
12+
13+
!!! warning
14+
The `netcdf-tools/2024` version uses an old interface that won't load views correctly.
15+
16+
All users of version `2024` should upgrade to `2025` as soon as possible.
17+
18+
19+
The packages exposed via the `default` and `modules` views in `netcdf-tools/2025:v1` are:
20+
21+
* [cdo@2.5.2](https://packages.spack.io/package.html?name=cdo)
22+
* [cray-mpich@8.1.32](https://packages.spack.io/package.html?name=cray-mpich)
23+
* [eccodes@2.41.0](https://packages.spack.io/package.html?name=eccodes)
24+
* [ferret@7.6.0](https://packages.spack.io/package.html?name=ferret)
25+
* Only provided in Eiger because its build configuration hard-codes x86 instructions.
26+
* [gcc@14.3.0](https://packages.spack.io/package.html?name=gcc)
27+
* [gdal@3.11.0](https://packages.spack.io/package.html?name=gdal)
28+
* [geos@3.13.1](https://packages.spack.io/package.html?name=geos)
29+
* [hdf5@1.14.6](https://packages.spack.io/package.html?name=hdf5)
30+
* [nco@5.3.3](https://packages.spack.io/package.html?name=nco)
31+
* [ncview@2.1.9](https://packages.spack.io/package.html?name=ncview)
32+
* [netcdf-c@4.9.2](https://packages.spack.io/package.html?name=netcdf-c)
33+
* [netcdf-cxx4@4.3.1](https://packages.spack.io/package.html?name=netcdf-cxx4)
34+
* [netcdf-fortran@4.6.1](https://packages.spack.io/package.html?name=netcdf-fortran)
35+
* [python@3.13.5](https://packages.spack.io/package.html?name=python)
36+
* [udunits@2.2.28](https://packages.spack.io/package.html?name=udunits)
37+
38+
## How to use
39+
40+
Use the different views to access the software
41+
42+
=== "the `netcdf` view"
43+
44+
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.
45+
46+
!!! example "test mpi compilers and python provided by netcdf-tools/2025"
47+
```console
48+
# start using the netcdf view
49+
$ uenv start --view=netcdf netcdf-tools/2025:v1
50+
51+
# the software is available
52+
$ which cdo
53+
/user-environment/env/netcdf/bin/cdo
54+
$ which gdal
55+
/user-environment/env/netcdf/bin/gdal
56+
$ gdal --version
57+
GDAL 3.11.0 "Eganville", released 2025/05/06
58+
```
59+
60+
!!! example "run applications directly using uenv run"
61+
```console
62+
# run ncview without having to start a uenv session
63+
$ uenv run netcdf-tools/2025:v1 --view=netcdf -- ncview
64+
65+
# create an alias that launches tools in netcdf-tools (add it to bashrc)
66+
$ alias ncx='uenv run --view=netcdf netcdf-tools/2025:v1 --'
67+
# then run commands:
68+
$ ncx ncview
69+
$ ncx cdo
70+
```
71+
72+
=== "modules"
73+
74+
The uenv provides modules for all of the software packages, which can be made available by using the `modules` view in
75+
No modules are loaded when a uenv starts, and have to be loaded individually using `module load`.
76+
77+
!!! example "starting netcdf-tools and using the provided modules"
78+
```console
79+
$ uenv start netcdf-tools/2025:v1 --view=modules
80+
$ module avail
81+
---------------------------- /user-environment/modules -----------------------------
82+
cdo/2.5.2 gdal/3.11.0 ncview/2.1.9 squashfs/4.6.1
83+
cray-mpich/8.1.32 geos/3.13.1 netcdf-c/4.9.2 udunits/2.2.28
84+
eccodes/2.41.0 hdf5/1.14.6 netcdf-cxx4/4.3.1
85+
ferret/7.6.0 libfabric/1.22.0 netcdf-fortran/4.6.1
86+
gcc/14.3.0 nco/5.3.3 python/3.13.5
87+
$ module load gdal
88+
$ gdal --version
89+
GDAL 3.11.0 "Eganville", released 2025/05/06
90+
```

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ nav:
102102
- 'Climate and Weather':
103103
- software/cw/index.md
104104
- 'WRF': software/cw/wrf.md
105+
- 'netcdf-tools': software/cw/netcdf-tools.md
105106
- 'Communication Libraries':
106107
- software/communication/index.md
107108
- 'Cray MPICH': software/communication/cray-mpich.md

0 commit comments

Comments
 (0)