Skip to content

Commit 8a2ca14

Browse files
committed
Update E3SM-Unified RC docs for new build_packages.py
1 parent cbae47c commit 8a2ca14

File tree

1 file changed

+16
-49
lines changed

1 file changed

+16
-49
lines changed

docs/releasing/creating-rcs/rc-e3sm-unified.md

Lines changed: 16 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -35,63 +35,30 @@ Edit `recipes/e3sm-unified/meta.yaml`:
3535
`e3sm_diags`, `mpas-analysis`, etc.)
3636

3737
---
38+
## 3. Run `build_packages.py`
3839

39-
## 3. Regenerate the Build Matrix
40+
If you are building packages for an RC version of E3SM-Unified, the script
41+
will build packages for Python 3.10 and the `nompi` and `hpc` versions of MPI
42+
by default (those needed for login and compute nodes, respectively, on HPC).
43+
You may wish to use the `--python` and `--mpi` flags to override these.
4044

41-
Run the matrix generator script to define combinations of Python and MPI:
45+
You should supply the `--conda` flag if not using `~/miniforge3`.
4246

4347
```bash
44-
cd recipes/e3sm-unified/configs
45-
rm *.yaml
46-
python generate.py
48+
./build_packages.py --conda ~/minforge3 --python 3.10 --mpi nompi hpc
4749
```
4850

49-
This produces matrix files like:
51+
The script will produce a matrix of files like:
5052

51-
* `mpi_mpich_python3.10.yaml`
52-
* `mpi_hpc_python3.10.yaml`
53+
* `configs/mpi_nompi_python3.10.yaml`
54+
* `configs/mpi_hpc_python3.10.yaml`
5355

54-
---
55-
56-
## 4. Edit `build_package.bash`
57-
58-
Update the channel list to include dev labels for any packages still in RC
59-
form. For example:
60-
61-
```bash
62-
channels="-c conda-forge/label/chemdyg_dev \
63-
-c conda-forge/label/e3sm_diags_dev \
64-
-c conda-forge/label/mache_dev \
65-
-c conda-forge/label/mpas_analysis_dev \
66-
-c conda-forge/label/zppy_dev \
67-
-c conda-forge/label/zstash_dev \
68-
-c conda-forge"
69-
```
70-
71-
Then define which matrix files to test. For example:
72-
73-
```bash
74-
for file in configs/mpi_mpich_python3.10.yaml configs/mpi_hpc_python3.10.yaml
75-
do
76-
conda build -m $file --override-channels $channels .
77-
done
78-
```
79-
80-
Make sure:
81-
82-
* You use `--override-channels` to isolate testing to dev packages
83-
* You only include dev labels for packages with RCs — use stable versions
84-
otherwise
56+
These are then used by `conda build` to build the appropriate variant of
57+
the conda package.
8558

8659
---
8760

88-
## 5. Build and Troubleshoot
89-
90-
Run the script:
91-
92-
```bash
93-
bash build_package.bash
94-
```
61+
## 4. Troubleshoot
9562

9663
If builds fail, consult the
9764
[Troubleshooting Conda Build Failures](rc-troubleshooting.md) guide.
@@ -100,7 +67,7 @@ resolution issues.
10067

10168
---
10269

103-
## 6. Make a draft PR
70+
## 5. Make a draft PR
10471

10572
Push the branch to your fork of `e3sm-unified` and make a draft PR to the
10673
main `e3sm-unified` repo. Use that PR to document progress and highlight
@@ -110,7 +77,7 @@ acces to E3SM's Confluence pages). See
11077

11178
---
11279

113-
## 7. Keeping updated on Confluence
80+
## 6. Keeping updated on Confluence
11481

11582
As deployment and testing progresses, you needs to make sure that the packages
11683
in your `update-to-<version>` branch match the
@@ -127,7 +94,7 @@ jargon**) what is new in their package that would be of interest to users.
12794

12895
---
12996

130-
## 8. Tag and Publish the RC
97+
## 7. Tag and Publish the RC
13198

13299
After test builds are successful:
133100

0 commit comments

Comments
 (0)