You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: docs/Reference/data.md
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,19 @@ The directory passed to `EntropySolver.from_file(eos_dir=...)` (or referenced th
19
19
|`solidus_P-S.dat`| 2-column $(P, S)$ | Solidus entropy at each pressure |
20
20
|`liquidus_P-S.dat`| 2-column $(P, S)$ | Liquidus entropy at each pressure |
21
21
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:
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
+
22
35
### File layout
23
36
24
37
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.
|`solidus_P-S.dat`, `liquidus_P-S.dat`| 2-column $(P, S)$ | Phase-boundary entropy at each pressure |
30
30
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:
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.
0 commit comments