Skip to content

Commit 639b7e1

Browse files
committed
Update non-bfb test documentation
1 parent eb13e2c commit 639b7e1

File tree

1 file changed

+42
-42
lines changed

1 file changed

+42
-42
lines changed

scripts/climate_reproducibility/README.md

+42-42
Original file line numberDiff line numberDiff line change
@@ -51,64 +51,64 @@ Primarily, the statistical analysis of the climates is done through [EVV](https:
5151
which will generate a portable test website to describe the results (pass or fail) in detail (see the extended output
5252
section below).
5353

54-
For E3SM supported machines, the `e3sm_simple` conda environment is provided for these tests and includes the `EVV`
55-
conda package. You can activate the `e3sm_simple` environment in the same way as `e3sm_unified` environment:
54+
For E3SM supported machines, the `cime_env` conda environment is provided for these tests and includes the `EVV`
55+
conda package. You can activate the `cime_env` environment in the same way as `e3sm_unified` environment:
5656

5757
```
58-
source <activate_path>/load_latest_e3sm_simple.sh
58+
source <activate_path>/load_latest_cime_env.sh
5959
```
6060

6161
where `<activate_path>` is the machine-specific location of the activation script as described on this confluence page:
6262

6363
https://acme-climate.atlassian.net/wiki/spaces/EIDMG/pages/780271950/Diagnostics+and+Analysis+Quickstart#DiagnosticsandAnalysisQuickstart-Accessingmetapackagesoftwarebyactivatingacondaenvironment
6464

6565
If you don't have access to confluence or are unable to activate this environment for whatever reason, you can install
66-
your own `e3sm_simple` conda environment with this command (once you have anaconda/miniconda installed):
66+
your own `cime_env` conda environment with this command (once you have anaconda/miniconda installed):
6767

6868
```
69-
conda create -n e3sm-simple -c conda-forge -c e3sm e3sm-simple
69+
conda create -n cime-env -c conda-forge -c e3sm cime-env
7070
```
7171

7272
*NOTE: If you run into problems with getting this environment working on your machine, please open an issue on E3SM's
73-
Github and tag @jhkennedy, or send Joseph H. Kennedy <[email protected]> an email.*
73+
Github and tag @mkstratos.
7474

75-
After you've activated the `e3sm_simple` environment, change to the `$E3SM/cime/scripts` directory (where `$E3SM` is the
75+
After you've activated the `cime_env` environment, change to the `$E3SM/cime/scripts` directory (where `$E3SM` is the
7676
directory containing E3SM). Then to run one of the tests, you will use the `create_test` script like normal.
7777
To run the `MVK` test and generate a baseline, you would run a command like:
7878

7979
```
80-
./create_test MVK_PL.ne4_oQU240.FC5AV1C-L -g --baseline-root "/PATH/TO/BASELINE"
80+
./create_test MVK_PS.ne4pg2_oQU480.F2010 -g --baseline-root "/PATH/TO/BASELINE"
8181
```
8282

8383
And to compare to the baseline, you would run a command like:
8484

8585
```
86-
./create_test MVK_PL.ne4_oQU240.FC5AV1C-L -c --baseline-root "/PATH/TO/BASELINE"
86+
./create_test MVK_PS.ne4pg2_oQU480.F2010 -c --baseline-root "/PATH/TO/BASELINE"
8787
```
8888

89-
*NOTE: The MVK run a 20 member ensemble for at least 13 months (using the last 12 for the
89+
*NOTE: The MVK runs a 30 member ensemble for 13 months (using the last 12 for the
9090
statistical tests) and, depending on the machine, may take some fiddling to execute within a particular
9191
queue's wallclock time limit. You may want to over-ride the requested walltime using `--walltime HH:MM:SS`
9292
option to `create_test`.*
9393

94-
The full set of commands to run the MVK test used on Cori are:
94+
The full set of commands to run the MVK test used on Perlmutter are:
9595

9696
*Generate a baseline*
9797
```
9898
cd $E3SM/cime/scripts
9999
100-
source /global/project/projectdirs/acme/software/anaconda_envs/load_latest_e3sm_simple.sh
100+
source /global/common/software/e3sm/anaconda_envs/load_latest_cime_env.sh
101101
102-
./create_test MVK_PL.ne4_ne4.FC5AV1C-L --baseline-root "${CSCRATCH}/baselines" --project acme -g -o --walltime 01:00:00
102+
./create_test MVK_PS.ne4pg2_oQU480.F2010 --baseline-root "${PSCRATCH}/baselines" --project e3sm -g -o --walltime 01:00:00
103103
```
104104

105105
*Compare to a baseline*
106106
```
107107
cd $E3SM/cime/scripts
108108
109-
source /global/project/projectdirs/acme/software/anaconda_envs/load_latest_e3sm_simple.sh
109+
source /global/common/software/e3sm/anaconda_envs/load_latest_cime_env.sh
110110
111-
./create_test MVK_PL.ne4_ne4.FC5AV1C-L --baseline-root "${CSCRATCH}/baselines" --project acme -c --walltime 01:00:00
111+
./create_test MVK_PS.ne4pg2_oQU480.F2010 --baseline-root "${PSCRATCH}/baselines" --project e3sm -c --walltime 01:00:00
112112
```
113113

114114
## Test pass/fail and extended output
@@ -117,9 +117,9 @@ When you launch these tests and compare to a baseline, CIME will output the loca
117117
something like this:
118118

119119
```
120-
# On cori-knl:
121-
./create_test MVK_PL.ne4_ne4.FC5AV1C-L --baseline-root "${CSCRATCH}/baselines" --project acme -c --walltime 01:00:00
122-
Creating test directory /global/cscratch1/sd/${USER}/acme_scratch/cori-knl/MVK_PL.ne4_ne4.FC5AV1C-L.cori-knl_intel.C.YYYYMMDD_HHMMSS_RANDOMID
120+
# On pm-cpu:
121+
./create_test MVK_PS.ne4pg2_oQU480.F2010 --baseline-root "${PSCRATCH}/baselines" --project e3sm -c --walltime 01:00:00
122+
Creating test directory ${PSCRATCH}/e3sm_scratch/pm-cpu/MVK_PS.ne4pg2_oQU480.F2010.pm-cpu_intel.C.YYYYMMDD_HHMMSS_RANDOMID
123123
```
124124

125125
Let's call that directory `$CASE_DIR`. Once all the jobs are finished, navigate to that directory and
@@ -129,7 +129,7 @@ you can `cat TestStatus` to determine if the test passed or failed by looking at
129129
cd $CASE_DIR
130130
cat TestStatus
131131
...
132-
PASS MVK_PL.ne4_ne4.FC5AV1C-L.cori-knl_intel BASELINE
132+
PASS MVK_PS.ne4pg2_oQU480.F2010.pm-cpu_intel BASELINE
133133
...
134134
135135
```
@@ -139,8 +139,8 @@ To get some basic summary statistics about the test that was run, look in the `T
139139
```
140140
2019-08-14 22:09:02: BASELINE PASS for test 'YYYYMMDD_HHMMSS_RANDOMID'.
141141
Case: YYYYMMDD_HHMMSS_RANDOMID; Test status: pass; Variables analyzed: 118; Rejecting: 0; Critical value: 13; Ensembles: statistically identical
142-
EVV results can be viewed at: /global/cscratch1/sd/${USER}/acme_scratch/cori-knl/MVK_PL.ne4_ne4.FC5AV1C-L.cori-knl_intel.C.YYYYMMDD_HHMMSS_RANDOMID/run/MVK_PL.ne4_ne4.FC5AV1C-L.cori-knl_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv/
143-
EVV viewing instructions can be found at: https://github.com/E3SM-Project/E3SM/blob/master/cime/scripts/climate_reproducibility/README.md#test-passfail-and-extended-output
142+
EVV results can be viewed at: ${PSCRATCH}/e3sm_scratch/pm-cpu/MVK_PS.ne4pg2_oQU480.F2010.pm-cpu_intel.C.YYYYMMDD_HHMMSS_RANDOMID/run/MVK_PS.ne4pg2_oQU480.F2010.pm-cpu_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv/
143+
EVV viewing instructions can be found at: https://github.com/ESMCI/CIME/blob/master/scripts/climate_reproducibility/README.md#test-passfail-and-extended-output
144144
```
145145

146146
EVV reports the location of the output website where you can see the details of the analysis. For
@@ -153,18 +153,18 @@ the website directory to your machine and view it using EVV.
153153

154154
### View via ssh
155155

156-
For this example, we'll assume the tests were run on Cori at NERSC, but these instructions should be
157-
easily adaptable to any E3SM supported machine. First, log into Cori via ssh and connect your local
158-
8080 port to the 8080 port on Cori:
156+
For this example, we'll assume the tests were run on Perlmutter at NERSC, but these instructions should be
157+
easily adaptable to any E3SM supported machine. First, log into Perlmutter via ssh and connect your local
158+
8080 port to the 8080 port on Perlmutter:
159159

160160
```
161-
ssh -L 8080:localhost:8080 [USER]@cori.nersc.gov
161+
ssh -L 8080:localhost:8080 [USER]@saul-p1.nersc.gov
162162
```
163163

164-
Activate the `e3sm_simple` environment:
164+
Activate the `cime_env` environment:
165165

166166
```
167-
source /global/project/projectdirs/acme/software/anaconda_envs/load_latest_e3sm_simple.sh
167+
source /global/common/software/e3sm/anaconda_envs/load_latest_cime_env.sh
168168
```
169169

170170
Navigate to the case's run directory:
@@ -176,7 +176,7 @@ pushd ${CASE_DIR}/run
176176
Then, using EVV, serve the website over port 8080:
177177

178178
```
179-
evv -o PGN_P1x1.ne4_ne4.FC5AV1C-L.cori-knl_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv -s 8080
179+
evv -o PGN_P1x1.ne4pg2_oQU480.F2010.pm-cpu_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv -s 8080
180180
```
181181

182182
Evv will then report to you the URL where you can view the website:
@@ -194,17 +194,17 @@ Evv will then report to you the URL where you can view the website:
194194
Extended Verification and Validation for Earth System Models
195195
--------------------------------------------------------------------
196196
197-
Current run: 2019-08-27 14:16:49
198-
User: kennedyj
199-
OS Type: Linux 4.12.14-150.27-default
200-
Machine: cori07
197+
Current run: 2024-03-06 07:56:37
198+
User: mek
199+
OS Type: Linux 5.14.21-150400.24.81_12.0.87-cray_shasta_c
200+
Machine: login31
201201
202202
203203
Serving HTTP on 0.0.0.0 port 8080 (http://0.0.0.0:8080/)
204204
205205
View the generated website by navigating to:
206206
207-
http://0.0.0.0:8080/PGN_P1x1.ne4_ne4.FC5AV1C-L.cori-knl_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv/index.html
207+
http://0.0.0.0:8080/PGN_P1x1.ne4pg2_oQU480.F2010.pm-cpu_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv/index.html
208208
209209
Exit by pressing `ctrl+c` to send a keyboard interrupt.
210210
```
@@ -214,20 +214,20 @@ browser to view the output website.
214214

215215
### View a local copy
216216

217-
For this example, we'll assume the tests were run on Cori at NERSC, but these instructions should be
218-
easily adaptable to any E3SM supported machine. Install `e3sm_simple` locally and activate it:
217+
For this example, we'll assume the tests were run on Perlmutter at NERSC, but these instructions should be
218+
easily adaptable to any E3SM supported machine. Install `cime_env` locally and activate it:
219219

220220
```
221-
conda create -n e3sm_simple -c conda-forge -c e3sm e3sm-simple
222-
conda activate e3sm_simple
221+
conda create -n cime_env -c conda-forge -c e3sm cime-env
222+
conda activate cime_env
223223
```
224224

225225
Then, copy the website to your local machine, and view it:
226226

227227
```
228228
# on your local machine
229-
scp -r /global/cscratch1/sd/${USER}/acme_scratch/cori-knl/MVK_PL.ne4_ne4.FC5AV1C-L.cori-knl_intel.C.YYYYMMDD_HHMMSS_RANDOMID/run/MVK_PL.ne4_ne4.FC5AV1C-L.cori-knl_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv .
230-
evv -o MVK_PL.ne4_ne4.FC5AV1C-L.cori-knl_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv -s
229+
scp -r ${PSCRATCH}/e3sm_scratch/pm-cpu/MVK_PS.ne4pg2_oQU480.F2010.pm-cpu_intel.C.YYYYMMDD_HHMMSS_RANDOMID/run/MVK_PS.ne4pg2_oQU480.F2010.pm-cpu_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv .
230+
evv -o MVK_PS.ne4pg2_oQU480.F2010.pm-cpu_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv -s
231231
--------------------------------------------------------------------
232232
______ __ __ __ __
233233
| ____| \ \ / / \ \ / /
@@ -249,7 +249,7 @@ evv -o MVK_PL.ne4_ne4.FC5AV1C-L.cori-knl_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv -s
249249
250250
View the generated website by navigating to:
251251
252-
http://0.0.0.0:8000/MVK_PL.ne4_ne4.FC5AV1C-L.cori-knl_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv/index.html
252+
http://0.0.0.0:8000/MVK_PS.ne4pg2_oQU480.F2010.pm-cpu_intel.C.YYYYMMDD_HHMMSS_RANDOMID.evv/index.html
253253
254254
Exit by pressing `ctrl+c` to send a keyboard interrupt.
255255
@@ -262,6 +262,6 @@ browser to view the output website.
262262
**Please note:** the output website uses some JavaScript to render elements of the page (especially figures),
263263
and opening up the `index.html` file using the `file://` protocol in a web browser will likely not work
264264
well (most browser have stopped allowing access to "local resources" like JavaScript through the `file://`
265-
protocol). You can view the website by either copying it to a hosted location (`~/WWW` which is hosted at
266-
`http://users.nccs.gov/~user` on Titan, for example) or copying it to your local machine and running a
265+
protocol). You can view the website by either copying it to a hosted location (`/global/cfs/projectdirs/e3sm/www/${USER}` which is hosted at
266+
`https://portal.nersc.gov/project/e3sm/${USER}` on NERSC, for example) or copying it to your local machine and running a
267267
local http server (included in python!) and viewing it through an address like `http://0.0.0.0:8000/index.html`.

0 commit comments

Comments
 (0)