Skip to content

Commit 4ee4d77

Browse files
committed
docs: add an example for updating namelists
1 parent 650ce02 commit 4ee4d77

File tree

3 files changed

+38
-4
lines changed

3 files changed

+38
-4
lines changed

Diff for: docs/pages.jl

+1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ pages = [
1818
"Investigate Problems" => "investigatingproblems.md",
1919
"Build options" => "buildoptions.md",
2020
"Input data" => "inputdata.md",
21+
"Update namelists" => "uget/update_namelists.md",
2122
"Other options" => "otheroptions.md",
2223
"User configuration" => "userconfiguration.md",
2324
"Parallel profiling" => "parallelprofiling.md",

Diff for: docs/src/uget/uget.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# User Documentation Uenv/Uget
22

3-
Alexandre Mary et al.
4-
53
The *uenv/uget* tool developped in Vortex is the counterpart of
64
*genv/gget* (MF/GCO op team), but user-oriented (hence the **u** instead
75
of **g**) and shareable with other users. It enables, in Vortex
@@ -20,9 +18,9 @@ use it properly.
2018
The following example shows how to modify components of an Arome-France
2119
*genv* catalog and modify its components piece by piece.
2220

23-
### Before first use
21+
### Before first use {#uget-first-use}
2422

25-
- load Genv/Gget (in your *profile*, if not already done):
23+
- on `belenos`, load Genv/Gget (in your *profile*, if not already done):
2624

2725
```bash
2826
export PATH=/home/mf/dp/marp/gco/public/bin:$PATH

Diff for: docs/src/uget/update_namelists.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Uget usecase: update namelists for Davai
2+
3+
In this example, we need to update namelists of Davai for the needs of a code modification
4+
(e.g. renaming of a variable, or adding a new block).
5+
Cf. "uget" section of this documentation for installation and a more thorough tutorial.
6+
7+
#### Setup a custom catalogue
8+
9+
The "uenv's" or catalogues of static input resources used by Davai are listed in the `conf/davai_nrv.ini` config file
10+
of the experiment.
11+
For instance, in `cy49.davai_specials.02@davai` is to be found a package of namelists.
12+
We first create a local copy of this catalogue with:
13+
14+
```
15+
uget.py hack env cy49.davai_specials.02@davai into cy49.davai_specials.02@@${USER}
16+
```
17+
18+
This will create a local catalogue file under `~/.vortexrc/hack/uget/${USER}/env/`.
19+
Make sure to modify the value in `davai_nrv.ini` to use your local copy.
20+
21+
#### Edit namelists
22+
23+
We then create a local copy of the namelist package listed in this catalogue `[email protected]@davai`:
24+
25+
```
26+
uget.py hack data [email protected]@davai into [email protected]@${USER}
27+
```
28+
29+
This creates a tgz file under `~/.vortexrc/hack/uget/${USER}/data/`, which then needs to be unpacked.
30+
Make sure to modify the catalogue file to use your local copy of the namelists.
31+
32+
You then can modify existing namelist files in the unpacked directory.
33+
34+
If your changes are required to run a contribution to IAL, don't forget to provide your catalogue and namelist package
35+
(paths) in your IAL Pull Request.

0 commit comments

Comments
 (0)