EOS export (Zalmoxis to SPIDER / Aragog)
Converts PALEOS pressure-temperature tables into the entropy-pressure (P-S) coordinates that SPIDER expects, and into the rectangular P-T grids that Aragog expects. Generates phase boundaries via direct PALEOS S(P, T) lookup (no inversion), and full 2D tables for density, temperature, heat capacity, thermal expansion, and adiabatic gradient. Solid and melt are written to separate files so SPIDER's mushy-zone mixing has phase-pure endpoints. Also produces the surface-entropy anchor consumed by SPIDER's interior solver.
eos_export
Export Zalmoxis/PALEOS EOS data to SPIDER-compatible P-S format.
SPIDER uses entropy-pressure (P-S) coordinates for its 2D EOS lookup tables and 1D phase boundaries. Zalmoxis and the PALEOS unified tables use pressure-temperature (P-T) coordinates. This module converts between the two coordinate systems.
Phase boundary conversion: T(P) melting curves -> S(P) phase boundaries via direct PALEOS S(P,T) lookup. No inversion needed.
Full EOS table generation: PALEOS P-T tables -> SPIDER P-S tables for density, temperature, heat capacity, thermal expansion, and adiabatic gradient, split into separate solid and melt files.
load_paleos_all_properties(eos_file)
Load all properties from a PALEOS unified table on a regular (logP, logT) grid.
Unlike eos_functions.load_paleos_unified_table (which only builds
density and nabla_ad interpolators), this function retains all 9
numeric columns for EOS export.
The parsed table is cached per process and file version, since a solve reads the same tables many times; the arrays are read-only, so copy one to change it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
eos_file
|
str or Path
|
Path to the PALEOS unified table (10-column format). |
required |
Returns:
| Type | Description |
|---|---|
dict
|
Keys:
- |
Raises:
| Type | Description |
|---|---|
FileNotFoundError
|
If |
PermissionError
|
If the table or a directory on its path cannot be read. |
ValueError
|
If a data line holds a token that is not a number ( |
StaleTableError
|
If the table is not the release its registry pins. |
Source code in src/zalmoxis/eos_export.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 | |
generate_spider_phase_boundaries(solidus_func, liquidus_func, eos_file, P_range=(100000.0, 200000000000.0), n_P=1000, output_dir=None, solid_eos_file=None, liquid_eos_file=None)
Generate SPIDER S(P) phase boundary files from T(P) melting curves.
For each pressure on a log-spaced grid, the solidus and liquidus temperatures are computed from the provided melting curve functions, then the corresponding entropy is looked up directly from the PALEOS unified table's entropy column. This avoids the numerical inversion required by the legacy approach (tools/generate_spider_phase_boundaries.py).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
solidus_func
|
callable
|
P [Pa] -> T_solidus [K]. Must accept scalar or array. |
required |
liquidus_func
|
callable
|
P [Pa] -> T_liquidus [K]. Must accept scalar or array. |
required |
eos_file
|
str or Path
|
Path to the PALEOS unified EOS table. |
required |
P_range
|
tuple of float
|
(P_min, P_max) in Pa. Default: (1e5, 200 GPa). |
(100000.0, 200000000000.0)
|
n_P
|
int
|
Number of pressure points (log-spaced). Default: 1000. |
1000
|
output_dir
|
str or Path or None
|
Directory where |
None
|
Returns:
| Type | Description |
|---|---|
dict
|
Keys:
- |
Notes
The written curves come from a PCHIP fit through 20 anchors spread over
the pressure range of the table, and each is then held at its running
maximum in pressure (np.maximum.accumulate), so it is non-decreasing
and flat above its highest value. This plateau is a solver-stability
choice, not a property of the tables: for PALEOS MgSiO3 the liquid-table
entropy along the liquidus peaks near 164 GPa and then falls, and with
the falling curve the time step of coupled SPIDER and Aragog runs
collapses at the onset of crystallisation. The size of the plateau in
entropy, temperature, melt fraction and entropy of fusion for 1 to 10
Earth-mass planets is given on the PROTEUS coupling page of the
documentation, under EOS table generation.
Source code in src/zalmoxis/eos_export.py
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 | |
generate_spider_eos_tables(eos_file, solidus_func, liquidus_func, P_range=(100000.0, 200000000000.0), n_P=150, n_S=150, output_dir=None, solid_eos_file=None, liquid_eos_file=None, solid_lowt_file=None)
Generate full SPIDER P-S EOS lookup tables from a PALEOS unified table.
For each phase (solid, melt), generates 5 files: - density_{phase}.dat - temperature_{phase}.dat - heat_capacity_{phase}.dat - thermal_exp_{phase}.dat - adiabat_temp_grad_{phase}.dat
plus valid_mask_{phase}.dat (see :func:_write_valid_mask). A cell is
1 where it lies inside the phase's temperature window (solid up to the
solidus, melt from the liquidus) and PALEOS gives a finite value for all
five properties there. It is 0 where a value was filled from the nearest
valid cell in its pressure column (SPIDER tables cannot hold NaN), and 0
where the temperature inverts but the table nabla_ad is not finite: that
cell keeps its other values and has nabla_ad written as 0.
The algorithm: 1. Load PALEOS P-T table with all properties (rho, s, cp, alpha, nabla_ad) 2. At each (P, T) grid point, we have S directly from the table 3. Classify each point as solid (T < T_solidus) or melt (T > T_liquidus) 4. For each phase, build a P-S grid by interpolation 5. Write 2D tables in SPIDER format
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
eos_file
|
str or Path
|
Path to the PALEOS unified EOS table. |
required |
solidus_func
|
callable
|
P [Pa] -> T_solidus [K]. |
required |
liquidus_func
|
callable
|
P [Pa] -> T_liquidus [K]. |
required |
P_range
|
tuple of float
|
(P_min, P_max) in Pa. |
(100000.0, 200000000000.0)
|
n_P
|
int
|
Number of pressure points in the output grid. |
150
|
n_S
|
int
|
Number of entropy points in the output grid. |
150
|
output_dir
|
str or Path or None
|
Directory for output files. If None, returns data without writing. |
None
|
solid_eos_file
|
str or Path or None
|
Two-phase PALEOS solid and liquid tables, used for every lookup when both are set. |
None
|
liquid_eos_file
|
str or Path or None
|
Two-phase PALEOS solid and liquid tables, used for every lookup when both are set. |
None
|
solid_lowt_file
|
str or Path or None
|
Low-temperature extension of the solid table, merged by
:func: |
None
|
Returns:
| Type | Description |
|---|---|
dict
|
Keys: |
Raises:
| Type | Description |
|---|---|
ValueError
|
When |
Source code in src/zalmoxis/eos_export.py
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 | |
generate_aragog_pt_tables(eos_file, P_range=(100000.0, 200000000000.0), n_P=1000, n_T=1000, output_dir=None, solidus_func=None, liquidus_func=None)
Generate Aragog-format P-T lookup tables from a PALEOS unified table.
Writes the full PALEOS P-T table as both solid-phase and melt-phase
files for density, heat capacity, and thermal expansivity. Each file
has 3 columns (pressure, temperature, value) in tab-separated format
with a 1-line header, matching the format Aragog reads from
interior_lookup_tables/EOS/dynamic/<eos_dir>/P-T/.
Both solid and melt files contain the same complete rectangular grid. Aragog handles the solid-liquid transition internally via its own solidus/liquidus curves and PhaseMixedParameters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
eos_file
|
str or Path
|
Path to the PALEOS unified EOS table. |
required |
P_range
|
tuple of float
|
(P_min, P_max) in Pa. |
(100000.0, 200000000000.0)
|
n_P
|
int
|
Number of pressure points. |
1000
|
n_T
|
int
|
Number of temperature points. |
1000
|
output_dir
|
str or Path or None
|
Directory for output files. Creates it if needed. |
None
|
solidus_func
|
callable or None
|
Unused. Kept for backward compatibility. |
None
|
liquidus_func
|
callable or None
|
Unused. Kept for backward compatibility. |
None
|
Returns:
| Type | Description |
|---|---|
dict or None
|
Keys: |
Source code in src/zalmoxis/eos_export.py
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 | |
generate_aragog_pt_tables_2phase(solid_eos_file, liquid_eos_file, P_range=(100000.0, 200000000000.0), n_P=1000, n_T=1000, output_dir=None)
Generate Aragog-format P-T lookup tables from PALEOS 2-phase tables.
Unlike generate_aragog_pt_tables (which uses the unified table and
writes identical solid/melt files), this function reads from separate
solid-phase and liquid-phase PALEOS tables. Each Aragog output file
contains the correct phase-specific properties, giving clean values
at the solidus and liquidus without interpolation across the melting
curve discontinuity.
This is essential for: - Correct Delta_S = S_liq(T_liq) - S_sol(T_sol) in the mixing flux - Entropy-conserving adiabatic IC via S(P,T) inversion - Matching SPIDER's entropy-based formulation
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
solid_eos_file
|
str or Path
|
Path to the PALEOS solid-phase table (10-column format). |
required |
liquid_eos_file
|
str or Path
|
Path to the PALEOS liquid-phase table (10-column format). |
required |
P_range
|
tuple of float
|
(P_min, P_max) in Pa. |
(100000.0, 200000000000.0)
|
n_P
|
int
|
Number of pressure points. |
1000
|
n_T
|
int
|
Number of temperature points. |
1000
|
output_dir
|
str or Path or None
|
Directory for output files. |
None
|
Returns:
| Type | Description |
|---|---|
dict or None
|
Keys: |
Source code in src/zalmoxis/eos_export.py
1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 | |
compute_surface_entropy(eos_file, T_surface, P_surface=100000.0, solidus_func=None, liquidus_func=None, solid_eos_file=None, liquid_eos_file=None)
Compute the entropy of a single (P, T) point using PALEOS tables.
Thin wrapper that performs just the surface-entropy lookup used to
initialise an isentropic adiabat, without integrating the full T(P)
profile down to the CMB. Needed by the entropy-IC cross-check paths
(AragogRunner._verify_entropy_ic and
common._verify_initial_entropy) which only need the scalar
S(P_surface, T_surface) for comparison against the primary
EntropyEOS.invert_temperature inversion.
The full compute_entropy_adiabat routine integrates an adiabat
from the surface to P_cmb and during bracket expansion can reach
(P_surface, 2*T_surface) tuples that land in the PALEOS "low-P
high-T" non-converged region (~100% NaN at P<1e7 Pa, T>5000 K for
MgSiO3 liquid). That region is physically vapour/plasma which the
liquid EOS fit does not cover. Since the cross-check only needs
entropy at the surface, this helper avoids the problematic bracket
expansion entirely.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
eos_file
|
str or Path
|
Path to the PALEOS unified EOS table (used when 2-phase tables are not provided). |
required |
T_surface
|
float
|
Surface temperature [K]. |
required |
P_surface
|
float
|
Surface pressure [Pa]. Default 1 bar = 1e5 Pa. |
100000.0
|
solidus_func
|
callable or None
|
Optional T_solidus(P) and T_liquidus(P) functions. Used only when (P_surface, T_surface) falls inside the mushy zone, in which case S is computed via phase-weighted blending. |
None
|
liquidus_func
|
callable or None
|
Optional T_solidus(P) and T_liquidus(P) functions. Used only when (P_surface, T_surface) falls inside the mushy zone, in which case S is computed via phase-weighted blending. |
None
|
solid_eos_file
|
str or Path or None
|
Optional PALEOS 2-phase tables. When provided and the point is inside the mushy zone, phase-specific entropy values are used instead of the unified-table lookup. Avoids the Clausius- Clapeyron inconsistency at the melting curve. |
None
|
liquid_eos_file
|
str or Path or None
|
Optional PALEOS 2-phase tables. When provided and the point is inside the mushy zone, phase-specific entropy values are used instead of the unified-table lookup. Avoids the Clausius- Clapeyron inconsistency at the melting curve. |
None
|
Returns:
| Type | Description |
|---|---|
dict
|
Keys:
|
Raises:
| Type | Description |
|---|---|
FileNotFoundError
|
If |
ValueError
|
If the entropy lookup at (P_surface, T_surface) returns NaN. This is a genuine out-of-table call (rare at surface conditions) and indicates a config mismatch or a corrupt table. |
Source code in src/zalmoxis/eos_export.py
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 | |
compute_entropy_adiabat(eos_file, T_surface, P_surface=100000.0, P_cmb=135000000000.0, n_points=500, solidus_func=None, liquidus_func=None, solid_eos_file=None, liquid_eos_file=None)
Compute an entropy-conserving adiabatic T(P) profile from PALEOS.
Starting from T_surface at P_surface, computes the target entropy S_target = S(P_surface, T_surface) and then inverts S(P, T) = S_target at each pressure to find T. This correctly handles phase boundaries (solidus/liquidus) where the Clausius-Clapeyron slope differs from the single-phase adiabatic gradient.
When solid_eos_file and liquid_eos_file are provided (2-phase
PALEOS tables), uses phase-specific entropy values for the mushy zone.
This gives clean Delta_S without interpolation across the melting curve
discontinuity. Falls back to the unified table if 2-phase tables are
not provided.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
eos_file
|
str or Path
|
Path to the PALEOS unified EOS table (used for single-phase regions and as fallback). |
required |
T_surface
|
float
|
Surface temperature [K]. |
required |
P_surface
|
float
|
Surface pressure [Pa]. |
100000.0
|
P_cmb
|
float
|
CMB pressure [Pa]. |
135000000000.0
|
n_points
|
int
|
Number of pressure points in the profile, at least 2 (the surface and the CMB). |
500
|
solidus_func
|
callable or None
|
P [Pa] -> T_solidus [K]. Required for mixed-phase entropy. |
None
|
liquidus_func
|
callable or None
|
P [Pa] -> T_liquidus [K]. Required for mixed-phase entropy. |
None
|
solid_eos_file
|
str or Path or None
|
Path to PALEOS solid-phase table. When provided with
|
None
|
liquid_eos_file
|
str or Path or None
|
Path to PALEOS liquid-phase table. |
None
|
Returns:
| Type | Description |
|---|---|
dict
|
Keys: |
Raises:
| Type | Description |
|---|---|
ValueError
|
If |
FileNotFoundError
|
If the PALEOS table is not found. |
Source code in src/zalmoxis/eos_export.py
1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 | |