Skip to content

Commit fa4f5ba

Browse files
Document the bundled test-data tarball in tutorial + reference
Following Harrison's PR #12 review: the standalone first-run tutorial did not link the SPIDER-format EOS tables that the nightly CI fetches from the GitHub release page. New users had to dig into the workflow yaml to find the URL. Adds a "Quick start: bundled test data" block to: * docs/Tutorials/firstrun.md (under the "Locate or stage the EOS tables" step), showing the exact curl + tar + ARAGOG_TEST_EOS_DIR setup the nightly CI uses. * docs/Reference/data.md (the canonical EOS-format reference). Both blocks point at the same release-asset URL and instruct users to set ARAGOG_TEST_EOS_DIR so the gated test suite picks it up.
1 parent 300f27d commit fa4f5ba

2 files changed

Lines changed: 24 additions & 1 deletion

File tree

docs/Reference/data.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,19 @@ The directory passed to `EntropySolver.from_file(eos_dir=...)` (or referenced th
1919
| `solidus_P-S.dat` | 2-column $(P, S)$ | Solidus entropy at each pressure |
2020
| `liquidus_P-S.dat` | 2-column $(P, S)$ | Liquidus entropy at each pressure |
2121

22+
### Quick start: bundled test data
23+
24+
A small SPIDER-format set is published as a release asset and used by the nightly CI. It is the fastest way to follow the [first-run tutorial](../Tutorials/firstrun.md) without a full PROTEUS / PALEOS install:
25+
26+
```bash
27+
mkdir -p /tmp/aragog-test-data
28+
curl -sL -o /tmp/spider_eos.tar.gz \
29+
https://github.com/FormingWorlds/aragog/releases/download/test-data-v1/spider_eos_test_data.tar.gz
30+
tar xzf /tmp/spider_eos.tar.gz -C /tmp/aragog-test-data/
31+
```
32+
33+
The unpacked directory `/tmp/aragog-test-data/spider_eos/` is a drop-in `eos_dir`. Set `ARAGOG_TEST_EOS_DIR=/tmp/aragog-test-data/spider_eos` so the gated unit + smoke tests pick it up automatically.
34+
2235
### File layout
2336

2437
The 2D tables follow SPIDER's text format: a header followed by a flat list of three-column $(P, S, Q)$ rows on a regular pressure-entropy grid.

docs/Tutorials/firstrun.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,17 @@ Aragog's entropy solver requires a directory containing the following files:
2828
| `adiabat_temp_grad_solid.dat`, `adiabat_temp_grad_melt.dat` | 2D P-S grid | $(\partial T/\partial P)_S$ |
2929
| `solidus_P-S.dat`, `liquidus_P-S.dat` | 2-column $(P, S)$ | Phase-boundary entropy at each pressure |
3030

31-
In a PROTEUS coupled run these tables are produced from the configured PALEOS or Wolf-Bower P-T file by the PROTEUS wrapper. For standalone work, point `eos_dir` at any directory containing this set.
31+
For a quick standalone walkthrough you can fetch a small SPIDER-format set bundled as a release asset:
32+
33+
```bash
34+
mkdir -p /tmp/aragog-test-data
35+
curl -sL -o /tmp/spider_eos.tar.gz \
36+
https://github.com/FormingWorlds/aragog/releases/download/test-data-v1/spider_eos_test_data.tar.gz
37+
tar xzf /tmp/spider_eos.tar.gz -C /tmp/aragog-test-data/
38+
export ARAGOG_TEST_EOS_DIR=/tmp/aragog-test-data/spider_eos
39+
```
40+
41+
The same tarball is what the nightly CI populates before the smoke + slow tiers run. In a PROTEUS coupled run these tables are produced from the configured PALEOS or Wolf-Bower P-T file by the PROTEUS wrapper. For standalone work, point `eos_dir` at any directory containing this set.
3242

3343
## 2. Scaffold a configuration
3444

0 commit comments

Comments
 (0)