Skip to content

Commit fc2d61c

Browse files
committed
alias cluster info
1 parent a0ce8d3 commit fc2d61c

2 files changed

Lines changed: 15 additions & 14 deletions

File tree

benchmarks/version_compat/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
This directory verifies that `gcamreader` works against GCAM output databases
44
produced by every available GCAM version (5.3 through 9.1), and captures
5-
per-version performance figures. It is designed to run on the **deception** HPC
6-
cluster under Slurm, after which its outputs are committed here as documentation.
5+
per-version performance figures. It is designed to run on an HPC cluster under
6+
Slurm, after which its outputs are committed here as documentation.
77

88
The full design rationale lives in
99
[`plans/gcam-version-verification.md`](../../plans/gcam-version-verification.md).
@@ -39,15 +39,15 @@ Each version's database lives at:
3939
atv.basex inf.basex tbl.basex tbli.basex txt.basex txtl.basex txtr.basex
4040
```
4141

42-
## Usage on deception
42+
## Usage on an HPC cluster
4343

4444
```bash
4545
# 1. Sync this repo to the cluster (or git pull there).
4646
cd $HOME/repos/github/gcamreader
4747

4848
# 2. Sanity-check a single version interactively first.
4949
module purge && module load python/3.13.5 java/17.0.18
50-
source /people/d3y010/envs/gcamreader/bin/activate
50+
source $HOME/envs/gcamreader/bin/activate
5151
python benchmarks/version_compat/run_version_check.py \
5252
--version gcam-v8.2 \
5353
--db-root /rcfs/projects/GCAM/gcam-ci-run \
@@ -64,7 +64,8 @@ python benchmarks/version_compat/aggregate_results.py \
6464
```
6565

6666
The harness and Slurm script require a Java runtime (`java/17.0.18`) and access
67-
to the GCAM database filesystem. Both are present on deception via Lmod.
67+
to the GCAM database filesystem. Both are typically provided on an HPC cluster
68+
via Lmod.
6869

6970
## Status code reference
7071

@@ -82,8 +83,8 @@ where the bundled queries diverge from a given GCAM schema.
8283

8384
## Latest results
8485

85-
The committed run (`gcamreader 1.5.0`, Python 3.13.5, Java 17.0.18 on
86-
deception) verified **all 22 of 22** versions as `PASS`. See
86+
The committed run (`gcamreader 1.5.0`, Python 3.13.5, Java 17.0.18 on an HPC
87+
cluster) verified **all 22 of 22** versions as `PASS`. See
8788
[`results/VERIFIED_VERSIONS.md`](results/VERIFIED_VERSIONS.md) for the full
8889
matrix and [`docs/verified_versions.rst`](../../docs/verified_versions.rst) for
8990
the rendered documentation page.

docs/verified_versions.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ per-version performance figures.
88

99
.. note::
1010

11-
These results were produced on the PNNL **deception** HPC cluster using the
12-
harness in ``benchmarks/version_compat/``. To regenerate them, see the
11+
These results were produced on an HPC cluster using the harness in
12+
``benchmarks/version_compat/``. To regenerate them, see the
1313
:ref:`reproducing` section below.
1414

1515
Test environment
@@ -176,9 +176,9 @@ The complete harness, Slurm job, and raw results live under
176176
* ``results/`` — the committed raw outputs, including per-version JSON and the
177177
Slurm logs for each task.
178178

179-
The steps below reproduce the full study from scratch on the **deception**
180-
cluster. Adjust the module names, paths, and Slurm account/partition for your
181-
own system as needed.
179+
The steps below reproduce the full study from scratch on an HPC cluster.
180+
Adjust the module names, paths, and Slurm account/partition for your own
181+
system as needed.
182182

183183
1. **Clone the repository.** Pick a location on a filesystem your compute nodes
184184
can read (e.g. your home or project space) and clone the project there.
@@ -207,8 +207,8 @@ own system as needed.
207207

208208
.. code-block:: bash
209209
210-
python3 -m venv /people/$USER/envs/gcamreader
211-
source /people/$USER/envs/gcamreader/bin/activate
210+
python3 -m venv $HOME/envs/gcamreader
211+
source $HOME/envs/gcamreader/bin/activate
212212
python -m pip install --upgrade pip
213213
214214
4. **Install gcamreader into the environment.** Installing it (rather than

0 commit comments

Comments
 (0)