xeos 0.1.0__py3-none-any.whl

xeos/__init__.py

@@ -0,0 +1,37 @@
+"""xeos: lightweight, xarray-enabled wrappers for seawater equations of state.
+
+Pick the EOS that matches your ocean-model run — by the model's own selector
+string — and apply it to xarray/dask data with a uniform API::
+
+    import xeos
+    eos = xeos.from_model("MOM6", "WRIGHT_FULL")
+    density = eos.rho(theta, salt, pressure)   # theta, salt, pressure as DataArrays
+
+See :func:`xeos.list_eos` for the available equations of state.
+"""
+
+from . import backends  # noqa: F401  (registers all built-in EOS at import time)
+
+from .eos import EquationOfState
+from .models import from_model, equation_of_state, MODEL_SELECTORS
+from .api import rho, alpha, beta, specific_volume
+from .registry import list_eos, get_backend
+from .conventions import TemperatureKind, SalinityKind, PressureUnit
+from .version import __version__
+
+__all__ = [
+    "EquationOfState",
+    "from_model",
+    "equation_of_state",
+    "MODEL_SELECTORS",
+    "rho",
+    "alpha",
+    "beta",
+    "specific_volume",
+    "list_eos",
+    "get_backend",
+    "TemperatureKind",
+    "SalinityKind",
+    "PressureUnit",
+    "__version__",
+]

xeos/api.py

@@ -0,0 +1,34 @@
+"""Functional shims: ``xeos.rho(t, s, p, eos=...)`` and friends.
+
+Thin wrappers over :class:`~xeos.eos.EquationOfState` for one-off calls.  For
+repeated use, build an ``EquationOfState`` once (via :func:`xeos.equation_of_state`
+or :func:`xeos.from_model`) and call its methods.
+"""
+
+from .models import equation_of_state
+
+__all__ = ["rho", "alpha", "beta", "specific_volume"]
+
+
+def _eos(eos, pressure_input_unit, params):
+    return equation_of_state(eos, pressure_input_unit=pressure_input_unit, **params)
+
+
+def rho(t, s, p, eos, pressure_input_unit="dbar", **params):
+    """In-situ density [kg m-3] from the named ``eos``."""
+    return _eos(eos, pressure_input_unit, params).rho(t, s, p)
+
+
+def alpha(t, s, p, eos, pressure_input_unit="dbar", **params):
+    """Thermal expansion coefficient [degC-1] from the named ``eos``."""
+    return _eos(eos, pressure_input_unit, params).alpha(t, s, p)
+
+
+def beta(t, s, p, eos, pressure_input_unit="dbar", **params):
+    """Haline contraction coefficient [(salt unit)-1] from the named ``eos``."""
+    return _eos(eos, pressure_input_unit, params).beta(t, s, p)
+
+
+def specific_volume(t, s, p, eos, pressure_input_unit="dbar", **params):
+    """Specific volume [m3 kg-1] from the named ``eos``."""
+    return _eos(eos, pressure_input_unit, params).specific_volume(t, s, p)

xeos/backends/__init__.py

@@ -0,0 +1,17 @@
+"""Importing this package registers all built-in EOS backends.
+
+Each module calls :func:`xeos.registry.register` at import time, so importing
+the package populates the global registry.  New schemes are added by dropping a
+module here and importing it below.
+"""
+
+from . import _linear  # noqa: F401
+from . import _wright  # noqa: F401
+from . import _jmd95  # noqa: F401
+from . import _unesco  # noqa: F401
+from . import _mdjwf  # noqa: F401
+from . import _roquet  # noqa: F401
+from . import _roquet_spv  # noqa: F401
+from . import _roquet_idealized  # noqa: F401
+from . import _mpas  # noqa: F401
+from . import _teos10  # noqa: F401

xeos/backends/_jmd95.py

@@ -0,0 +1,86 @@
+"""Jackett & McDougall (1995) equation of state (the MITgcm / ECCO standard).
+
+Jackett, D.R. & T.J. McDougall (1995): "Minimal adjustment of hydrographic
+profiles to achieve static stability." J. Atmos. Oceanic Technol., 12, 381-389.
+
+Coefficients ported verbatim from the MITgcm reference implementation (also used
+by ``fastjmd95``).  This same fit is what MOM6 calls ``UNESCO`` / ``JACKETT_MCD``
+(``MOM_EOS_UNESCO.F90``), so those MOM6 selectors resolve here too.  State
+variables: potential temperature [degC], practical
+salinity [PSU], sea pressure [dbar].  Density derivatives are left to the
+facade's centred finite-difference fallback (the reference analytic derivatives
+carry a known typo); the fallback is accurate to ~1e-6 (O(h^2) truncation).
+"""
+
+import numpy as np
+
+from ..conventions import TemperatureKind, SalinityKind, PressureUnit
+from ..registry import EOSBackend, register
+
+# Density of fresh / sea water at p = 0.
+_CFW = np.array([999.842594, 6.793952e-02, -9.095290e-03,
+                 1.001685e-04, -1.120083e-06, 6.536332e-09])
+_CSW = np.array([8.244930e-01, -4.089900e-03, 7.643800e-05, -8.246700e-07,
+                 5.387500e-09, -5.724660e-03, 1.022700e-04, -1.654600e-06,
+                 4.831400e-04])
+# Secant bulk modulus coefficients.
+_CKFW = np.array([1.965933e04, 1.444304e02, -1.706103e00,
+                  9.648704e-03, -4.190253e-05])
+_CKSW = np.array([5.284855e01, -3.101089e-01, 6.283263e-03, -5.084188e-05,
+                  3.886640e-01, 9.085835e-03, -4.619924e-04])
+_CKP = np.array([3.186519e00, 2.212276e-02, -2.984642e-04, 1.956415e-06,
+                 6.704388e-03, -1.847318e-04, 2.059331e-07, 1.480266e-04,
+                 2.102898e-04, -1.202016e-05, 1.394680e-07, -2.040237e-06,
+                 6.128773e-08, 6.207323e-10])
+
+
+def _rho_surface(s, t):
+    t2 = t * t
+    t3 = t2 * t
+    t4 = t3 * t
+    s3o2 = s * np.sqrt(s)
+    rho_fw = (_CFW[0] + _CFW[1] * t + _CFW[2] * t2 + _CFW[3] * t3
+              + _CFW[4] * t4 + _CFW[5] * t4 * t)
+    return (rho_fw
+            + s * (_CSW[0] + _CSW[1] * t + _CSW[2] * t2 + _CSW[3] * t3 + _CSW[4] * t4)
+            + s3o2 * (_CSW[5] + _CSW[6] * t + _CSW[7] * t2)
+            + _CSW[8] * s * s)
+
+
+def _bulk_modulus(s, t, p_bar):
+    t2 = t * t
+    t3 = t2 * t
+    t4 = t3 * t
+    s3o2 = s * np.sqrt(s)
+    p = p_bar
+    p2 = p * p
+    bm = _CKFW[0] + _CKFW[1] * t + _CKFW[2] * t2 + _CKFW[3] * t3 + _CKFW[4] * t4
+    bm = (bm
+          + s * (_CKSW[0] + _CKSW[1] * t + _CKSW[2] * t2 + _CKSW[3] * t3)
+          + s3o2 * (_CKSW[4] + _CKSW[5] * t + _CKSW[6] * t2))
+    bm = (bm
+          + p * (_CKP[0] + _CKP[1] * t + _CKP[2] * t2 + _CKP[3] * t3)
+          + p * s * (_CKP[4] + _CKP[5] * t + _CKP[6] * t2)
+          + p * s3o2 * _CKP[7]
+          + p2 * (_CKP[8] + _CKP[9] * t + _CKP[10] * t2)
+          + p2 * s * (_CKP[11] + _CKP[12] * t + _CKP[13] * t2))
+    return bm
+
+
+def density(t, s, p_dbar):
+    """In-situ density [kg m-3] from potential temp, practical salinity, dbar."""
+    p_bar = 0.1 * p_dbar
+    rho_s = _rho_surface(s, t)
+    bulk = _bulk_modulus(s, t, p_bar)
+    return rho_s / (1.0 - p_bar / bulk)
+
+
+register(EOSBackend(
+    id="jmd95",
+    density=density,
+    temperature=TemperatureKind.POTENTIAL,
+    salinity=SalinityKind.PRACTICAL,
+    pressure_unit=PressureUnit.DBAR,
+    reference="Jackett & McDougall (1995), J. Atmos. Oceanic Technol., 12, 381-389.",
+    description="UNESCO/EOS-80 refit; MITgcm JMD95Z/JMD95P, ECCO standard.",
+))

xeos/backends/_linear.py

@@ -0,0 +1,52 @@
+"""Linear equation of state: rho = rho0 + drho_dT * T + drho_dS * S.
+
+Used by all three target models (MOM6 ``LINEAR``, MITgcm ``LINEAR``,
+Oceananigans ``LinearEquationOfState``).  The coefficients are configurable;
+the registered default uses MITgcm-style values.
+"""
+
+from ..conventions import TemperatureKind, SalinityKind, PressureUnit
+from ..registry import EOSBackend, register
+
+# MITgcm-style defaults (rhoNil, tAlpha, sBeta).
+DEFAULT_RHO0 = 999.8
+DEFAULT_TALPHA = 2.0e-4  # thermal expansion [degC-1]
+DEFAULT_SBETA = 7.4e-4   # haline contraction [PSU-1]
+
+
+def make_linear(rho0=DEFAULT_RHO0, talpha=DEFAULT_TALPHA, sbeta=DEFAULT_SBETA,
+                eos_id="linear"):
+    """Build a linear :class:`EOSBackend` from expansion/contraction coefficients.
+
+    ``rho = rho0 * (1 - talpha * T + sbeta * S)``, so ``drho/dT = -rho0*talpha``
+    and ``drho/dS = rho0*sbeta`` are exact constants.
+    """
+    drdt = -rho0 * talpha
+    drds = rho0 * sbeta
+
+    def density(t, s, p):
+        return rho0 + drdt * t + drds * s
+
+    def drho_dt(t, s, p):
+        return drdt + 0.0 * t
+
+    def drho_ds(t, s, p):
+        return drds + 0.0 * s
+
+    return EOSBackend(
+        id=eos_id,
+        density=density,
+        drho_dt=drho_dt,
+        drho_ds=drho_ds,
+        temperature=TemperatureKind.POTENTIAL,
+        salinity=SalinityKind.PRACTICAL,
+        pressure_unit=PressureUnit.DBAR,
+        reference="Linear EOS (configurable thermal/haline coefficients).",
+        description=(
+            f"rho0={rho0}, talpha={talpha}, sbeta={sbeta}; "
+            "pressure-independent (incompressible)."
+        ),
+    )
+
+
+register(make_linear())

xeos/backends/_mdjwf.py

@@ -0,0 +1,59 @@
+"""McDougall, Jackett, Wright & Feistel (2003) equation of state.
+
+McDougall, T.J., D.R. Jackett, D.G. Wright & R. Feistel (2003): "Accurate and
+computationally efficient algorithms for potential temperature and density of
+seawater." J. Atmos. Oceanic Technol., 20, 730-741.
+
+A rational-function (numerator / denominator) fit; MITgcm ``eosType='MDJWF'``.
+Coefficients ported from the MITgcm reference (``MITgcmutils.density.mdjwf``).
+
+State variables: potential temperature [degC], practical salinity [PSU], sea
+pressure [dbar].
+"""
+
+import numpy as np
+
+from ..conventions import TemperatureKind, SalinityKind, PressureUnit
+from ..registry import EOSBackend, register
+
+_NUM = np.array([7.35212840e+00, -5.45928211e-02, 3.98476704e-04, 2.96938239e+00,
+                 -7.23268813e-03, 2.12382341e-03, 1.04004591e-02, 1.03970529e-07,
+                 5.18761880e-06, -3.24041825e-08, -1.23869360e-11, 9.99843699e+02])
+_DEN = np.array([7.28606739e-03, -4.60835542e-05, 3.68390573e-07, 1.80809186e-10,
+                 2.14691708e-03, -9.27062484e-06, -1.78343643e-10, 4.76534122e-06,
+                 1.63410736e-09, 5.30848875e-06, -3.03175128e-16, -1.27934137e-17,
+                 1.00000000e+00])
+
+
+def density(t, s, p_dbar):
+    """In-situ density [kg m-3] from potential temp, practical salinity, dbar."""
+    t1 = t
+    t2 = t1 * t1
+    s1 = s
+    p1 = p_dbar
+    sp5 = np.sqrt(s1)
+    p1t1 = p1 * t1
+
+    num = (_NUM[11]
+           + t1 * (_NUM[0] + t1 * (_NUM[1] + _NUM[2] * t1))
+           + s1 * (_NUM[3] + _NUM[4] * t1 + _NUM[5] * s1)
+           + p1 * (_NUM[6] + _NUM[7] * t2 + _NUM[8] * s1
+                   + p1 * (_NUM[9] + _NUM[10] * t2)))
+    den = (_DEN[12]
+           + t1 * (_DEN[0] + t1 * (_DEN[1] + t1 * (_DEN[2] + t1 * _DEN[3])))
+           + s1 * (_DEN[4] + t1 * (_DEN[5] + _DEN[6] * t2)
+                   + sp5 * (_DEN[7] + _DEN[8] * t2))
+           + p1 * (_DEN[9] + p1t1 * (_DEN[10] * t2 + _DEN[11] * p1)))
+    return num / den
+
+
+register(EOSBackend(
+    id="mdjwf",
+    density=density,
+    temperature=TemperatureKind.POTENTIAL,
+    salinity=SalinityKind.PRACTICAL,
+    pressure_unit=PressureUnit.DBAR,
+    reference="McDougall, Jackett, Wright & Feistel (2003), "
+              "J. Atmos. Oceanic Technol., 20, 730-741.",
+    description="Rational-function EOS; MITgcm MDJWF.",
+))

xeos/backends/_mpas.py

@@ -0,0 +1,103 @@
+"""MPAS-Ocean (MPAS-O) equations of state.
+
+MPAS-O (the ocean component of E3SM) selects its EOS with the namelist option
+``config_eos_type``, which accepts exactly three values -- ``linear``, ``jm`` and
+``wright`` -- implemented in
+``components/mpas-ocean/src/shared/mpas_ocn_equation_of_state_{linear,jm,wright}.F``.
+The ``jm`` (Jackett & McDougall 1995) and ``wright`` (Wright 1997) kernels are
+byte-for-byte identical -- same coefficients and same algebraic form -- to xeos's
+existing :mod:`._jmd95` and :mod:`._wright` (reduced-range) kernels, so this module
+*reuses those kernel functions* rather than re-vendoring the coefficients; the
+MPAS-O truth fixtures (``mpas-jm`` / ``mpas-wright``) validate that reuse against
+MPAS-O's own compiled Fortran. ``mpas-linear`` is the linear form with MPAS-O's
+namelist defaults baked in.
+
+State variables (all three): potential temperature [degC], practical salinity
+[PSU]; ``jm`` takes sea pressure [dbar], ``wright`` pressure [Pa], ``linear`` is
+pressure-independent.
+
+Two MPAS-O specifics are *documented here but intentionally not exposed* (the
+facade takes pressure as an input, and the validation grid is in-range):
+
+* **T/S clamping** before the polynomial -- ``jm`` clamps to T in [-2, 40] degC and
+  S in [0, 42] PSU; ``wright`` to T in [-3, 30] degC and S in [28, 38] PSU.
+* **depth -> pressure** -- ``jm`` derives a per-layer reference pressure in bars
+  from depth via a POP/Levitus polynomial
+  ``P_bar(z) = 0.059808*(exp(-0.025*z) - 1) + 0.100766*z + 2.28405e-7*z**2``;
+  ``wright`` uses the Boussinesq linearisation ``p = -rho0*g*z``.
+"""
+
+from ..conventions import TemperatureKind, SalinityKind, PressureUnit
+from ..registry import EOSBackend, register
+from ._jmd95 import density as _jmd95_density
+from ._wright import REDUCED as _WRIGHT_REDUCED, _make as _wright_make
+
+# --- mpas-linear: rho = RhoRef - Alpha*(T - Tref) + Beta*(S - Sref) -----------
+# MPAS-O Registry defaults (config_eos_linear_*): a *decrease* with temperature
+# (-Alpha) and *increase* with salinity (+Beta); Alpha/Beta are dimensional
+# (kg m-3 per degC / per PSU), not normalised by density.
+_RHO_REF = 1000.0   # config_eos_linear_densityref [kg m-3]
+_ALPHA = 0.2        # config_eos_linear_alpha      [kg m-3 degC-1]
+_BETA = 0.8         # config_eos_linear_beta       [kg m-3 PSU-1]
+_T_REF = 5.0        # config_eos_linear_Tref       [degC]
+_S_REF = 35.0       # config_eos_linear_Sref       [PSU]
+
+
+def _mpas_linear_density(t, s, p):
+    return _RHO_REF - _ALPHA * (t - _T_REF) + _BETA * (s - _S_REF)
+
+
+def _mpas_linear_drho_dt(t, s, p):
+    return -_ALPHA + 0.0 * t
+
+
+def _mpas_linear_drho_ds(t, s, p):
+    return _BETA + 0.0 * s
+
+
+# --- mpas-wright: reuse the reduced-range Wright (1997) kernel -----------------
+_wright_density, _wright_drho_dt, _wright_drho_ds = _wright_make(_WRIGHT_REDUCED)
+
+
+register(EOSBackend(
+    id="mpas-linear",
+    density=_mpas_linear_density,
+    drho_dt=_mpas_linear_drho_dt,
+    drho_ds=_mpas_linear_drho_ds,
+    temperature=TemperatureKind.POTENTIAL,
+    salinity=SalinityKind.PRACTICAL,
+    pressure_unit=PressureUnit.DBAR,
+    reference="MPAS-O config_eos_type='linear' (mpas_ocn_equation_of_state_linear.F).",
+    description=(
+        f"rho = {_RHO_REF} - {_ALPHA}*(T-{_T_REF}) + {_BETA}*(S-{_S_REF}); "
+        "MPAS-O namelist defaults; pressure-independent (incompressible)."
+    ),
+))
+
+register(EOSBackend(
+    id="mpas-jm",
+    density=_jmd95_density,
+    temperature=TemperatureKind.POTENTIAL,
+    salinity=SalinityKind.PRACTICAL,
+    pressure_unit=PressureUnit.DBAR,
+    reference=("MPAS-O config_eos_type='jm' (mpas_ocn_equation_of_state_jm.F); "
+               "Jackett & McDougall (1995), J. Atmos. Oceanic Technol., 12, 381-389."),
+    description=("Jackett-McDougall (1995) UNESCO/EOS-80 refit; identical kernel to "
+                 "xeos 'jmd95'. MPAS-O clamps T,S and derives pressure from depth "
+                 "(documented in this module; not applied here)."),
+))
+
+register(EOSBackend(
+    id="mpas-wright",
+    density=_wright_density,
+    drho_dt=_wright_drho_dt,
+    drho_ds=_wright_drho_ds,
+    temperature=TemperatureKind.POTENTIAL,
+    salinity=SalinityKind.PRACTICAL,
+    pressure_unit=PressureUnit.PASCAL,
+    reference=("MPAS-O config_eos_type='wright' (mpas_ocn_equation_of_state_wright.F); "
+               "Wright (1997), J. Atmos. Oceanic Technol., 14, 735-740."),
+    description=("Wright (1997) reduced-range coefficients (Table 1, last column); "
+                 "identical kernel to xeos 'wright97-reduced'. MPAS-O clamps T,S and "
+                 "uses Boussinesq pressure p=-rho0*g*z (documented; not applied here)."),
+))

xeos/backends/_roquet.py

@@ -0,0 +1,162 @@
+"""Roquet et al. (2015) 55-term polynomial approximation to TEOS-10.
+
+Roquet, F., Madec, G., McDougall, T.J., Barker, P.M. (2015): "Accurate
+polynomial expressions for the density and specific volume of seawater using the
+TEOS-10 standard." Ocean Modelling, 90, 29-43.
+
+This is the Boussinesq in-situ density form (``polyTEOS10_bsq``) used by
+Oceananigans / SeawaterPolynomials.jl ``TEOS10EquationOfState``.  Coefficients
+ported verbatim from Fabien Roquet's reference ``polyTEOS10.py``.
+
+State variables: conservative temperature [degC], absolute salinity [g/kg], and
+sea pressure [dbar] (numerically ~ geopotential depth in m).
+"""
+
+from ..conventions import TemperatureKind, SalinityKind, PressureUnit
+from ..registry import EOSBackend, register
+
+# Reduced-variable normalisation.
+_SAu = 40.0 * 35.16504 / 35.0
+_CTu = 40.0
+_Zu = 1.0e4
+_dS = 32.0
+
+# Vertical reference profile of density r0(pp).
+_R0 = (4.6494977072e+01, -5.2099962525e+00, 2.2601900708e-01,
+       6.4326772569e-02, 1.5616995503e-02, -1.7243708991e-03)
+
+# Density-anomaly coefficients R_{ijk} (i: salinity, j: temperature, k: pressure).
+R000 = 8.0189615746e+02; R100 = 8.6672408165e+02; R200 = -1.7864682637e+03
+R300 = 2.0375295546e+03; R400 = -1.2849161071e+03; R500 = 4.3227585684e+02
+R600 = -6.0579916612e+01; R010 = 2.6010145068e+01; R110 = -6.5281885265e+01
+R210 = 8.1770425108e+01; R310 = -5.6888046321e+01; R410 = 1.7681814114e+01
+R510 = -1.9193502195e+00; R020 = -3.7074170417e+01; R120 = 6.1548258127e+01
+R220 = -6.0362551501e+01; R320 = 2.9130021253e+01; R420 = -5.4723692739e+00
+R030 = 2.1661789529e+01; R130 = -3.3449108469e+01; R230 = 1.9717078466e+01
+R330 = -3.1742946532e+00; R040 = -8.3627885467e+00; R140 = 1.1311538584e+01
+R240 = -5.3563304045e+00; R050 = 5.4048723791e-01; R150 = 4.8169980163e-01
+R060 = -1.9083568888e-01; R001 = 1.9681925209e+01; R101 = -4.2549998214e+01
+R201 = 5.0774768218e+01; R301 = -3.0938076334e+01; R401 = 6.6051753097e+00
+R011 = -1.3336301113e+01; R111 = -4.4870114575e+00; R211 = 5.0042598061e+00
+R311 = -6.5399043664e-01; R021 = 6.7080479603e+00; R121 = 3.5063081279e+00
+R221 = -1.8795372996e+00; R031 = -2.4649669534e+00; R131 = -5.5077101279e-01
+R041 = 5.5927935970e-01; R002 = 2.0660924175e+00; R102 = -4.9527603989e+00
+R202 = 2.5019633244e+00; R012 = 2.0564311499e+00; R112 = -2.1311365518e-01
+R022 = -1.2419983026e+00; R003 = -2.3342758797e-02; R103 = -1.8507636718e-02
+R013 = 3.7969820455e-01
+
+# Thermal-expansion coefficients (a = -dr/dCT).
+ALP000 = -6.5025362670e-01; ALP100 = 1.6320471316e+00; ALP200 = -2.0442606277e+00
+ALP300 = 1.4222011580e+00; ALP400 = -4.4204535284e-01; ALP500 = 4.7983755487e-02
+ALP010 = 1.8537085209e+00; ALP110 = -3.0774129064e+00; ALP210 = 3.0181275751e+00
+ALP310 = -1.4565010626e+00; ALP410 = 2.7361846370e-01; ALP020 = -1.6246342147e+00
+ALP120 = 2.5086831352e+00; ALP220 = -1.4787808849e+00; ALP320 = 2.3807209899e-01
+ALP030 = 8.3627885467e-01; ALP130 = -1.1311538584e+00; ALP230 = 5.3563304045e-01
+ALP040 = -6.7560904739e-02; ALP140 = -6.0212475204e-02; ALP050 = 2.8625353333e-02
+ALP001 = 3.3340752782e-01; ALP101 = 1.1217528644e-01; ALP201 = -1.2510649515e-01
+ALP301 = 1.6349760916e-02; ALP011 = -3.3540239802e-01; ALP111 = -1.7531540640e-01
+ALP211 = 9.3976864981e-02; ALP021 = 1.8487252150e-01; ALP121 = 4.1307825959e-02
+ALP031 = -5.5927935970e-02; ALP002 = -5.1410778748e-02; ALP102 = 5.3278413794e-03
+ALP012 = 6.2099915132e-02; ALP003 = -9.4924551138e-03
+
+# Haline-contraction coefficients (b = dr/dSA, before /ss).
+BET000 = 1.0783203594e+01; BET100 = -4.4452095908e+01; BET200 = 7.6048755820e+01
+BET300 = -6.3944280668e+01; BET400 = 2.6890441098e+01; BET500 = -4.5221697773e+00
+BET010 = -8.1219372432e-01; BET110 = 2.0346663041e+00; BET210 = -2.1232895170e+00
+BET310 = 8.7994140485e-01; BET410 = -1.1939638360e-01; BET020 = 7.6574242289e-01
+BET120 = -1.5019813020e+00; BET220 = 1.0872489522e+00; BET320 = -2.7233429080e-01
+BET030 = -4.1615152308e-01; BET130 = 4.9061350869e-01; BET230 = -1.1847737788e-01
+BET040 = 1.4073062708e-01; BET140 = -1.3327978879e-01; BET050 = 5.9929880134e-03
+BET001 = -5.2937873009e-01; BET101 = 1.2634116779e+00; BET201 = -1.1547328025e+00
+BET301 = 3.2870876279e-01; BET011 = -5.5824407214e-02; BET111 = 1.2451933313e-01
+BET211 = -2.4409539932e-02; BET021 = 4.3623149752e-02; BET121 = -4.6767901790e-02
+BET031 = -6.8523260060e-03; BET002 = -6.1618945251e-02; BET102 = 6.2255521644e-02
+BET012 = -2.6514181169e-03; BET003 = -2.3025968587e-04
+
+
+def _reduced(ct, sa, p_dbar):
+    import numpy as np
+    ss = np.sqrt((sa + _dS) / _SAu)
+    tt = ct / _CTu
+    pp = p_dbar / _Zu
+    return ss, tt, pp
+
+
+def _r0(pp):
+    R00, R01, R02, R03, R04, R05 = _R0
+    return (((((R05 * pp + R04) * pp + R03) * pp + R02) * pp + R01) * pp + R00) * pp
+
+
+def _anomaly(ss, tt, pp):
+    rz3 = R013 * tt + R103 * ss + R003
+    rz2 = (R022 * tt + R112 * ss + R012) * tt + (R202 * ss + R102) * ss + R002
+    rz1 = ((((R041 * tt + R131 * ss + R031) * tt
+             + (R221 * ss + R121) * ss + R021) * tt
+            + ((R311 * ss + R211) * ss + R111) * ss + R011) * tt
+           + (((R401 * ss + R301) * ss + R201) * ss + R101) * ss + R001)
+    rz0 = (((((R060 * tt + R150 * ss + R050) * tt
+              + (R240 * ss + R140) * ss + R040) * tt
+             + ((R330 * ss + R230) * ss + R130) * ss + R030) * tt
+            + (((R420 * ss + R320) * ss + R220) * ss + R120) * ss + R020) * tt
+           + ((((R510 * ss + R410) * ss + R310) * ss + R210) * ss + R110) * ss + R010) * tt \
+        + (((((R600 * ss + R500) * ss + R400) * ss + R300) * ss + R200) * ss + R100) * ss + R000
+    return ((rz3 * pp + rz2) * pp + rz1) * pp + rz0
+
+
+def density(ct, sa, p_dbar):
+    """In-situ density [kg m-3] (conservative temp, absolute salinity, dbar)."""
+    ss, tt, pp = _reduced(ct, sa, p_dbar)
+    return _r0(pp) + _anomaly(ss, tt, pp)
+
+
+def _thermal_expansion_a(ct, sa, p_dbar):
+    """Boussinesq thermal expansion a = -dr/dCT [kg m-3 K-1]."""
+    ss, tt, pp = _reduced(ct, sa, p_dbar)
+    return ((ALP003 * pp
+             + ALP012 * tt + ALP102 * ss + ALP002) * pp
+            + ((ALP031 * tt + ALP121 * ss + ALP021) * tt
+               + (ALP211 * ss + ALP111) * ss + ALP011) * tt
+            + ((ALP301 * ss + ALP201) * ss + ALP101) * ss + ALP001) * pp \
+        + ((((ALP050 * tt + ALP140 * ss + ALP040) * tt
+             + (ALP230 * ss + ALP130) * ss + ALP030) * tt
+            + ((ALP320 * ss + ALP220) * ss + ALP120) * ss + ALP020) * tt
+           + (((ALP410 * ss + ALP310) * ss + ALP210) * ss + ALP110) * ss + ALP010) * tt \
+        + ((((ALP500 * ss + ALP400) * ss + ALP300) * ss + ALP200) * ss + ALP100) * ss + ALP000
+
+
+def _haline_contraction_b(ct, sa, p_dbar):
+    """Boussinesq haline contraction b = dr/dSA [kg m-3 (g/kg)-1]."""
+    ss, tt, pp = _reduced(ct, sa, p_dbar)
+    b = ((BET003 * pp
+          + BET012 * tt + BET102 * ss + BET002) * pp
+         + ((BET031 * tt + BET121 * ss + BET021) * tt
+            + (BET211 * ss + BET111) * ss + BET011) * tt
+         + ((BET301 * ss + BET201) * ss + BET101) * ss + BET001) * pp \
+        + ((((BET050 * tt + BET140 * ss + BET040) * tt
+             + (BET230 * ss + BET130) * ss + BET030) * tt
+            + ((BET320 * ss + BET220) * ss + BET120) * ss + BET020) * tt
+           + (((BET410 * ss + BET310) * ss + BET210) * ss + BET110) * ss + BET010) * tt \
+        + ((((BET500 * ss + BET400) * ss + BET300) * ss + BET200) * ss + BET100) * ss + BET000
+    return b / ss
+
+
+def drho_dt(ct, sa, p_dbar):
+    return -_thermal_expansion_a(ct, sa, p_dbar)
+
+
+def drho_ds(ct, sa, p_dbar):
+    return _haline_contraction_b(ct, sa, p_dbar)
+
+
+register(EOSBackend(
+    id="teos10-poly55",
+    density=density,
+    drho_dt=drho_dt,
+    drho_ds=drho_ds,
+    temperature=TemperatureKind.CONSERVATIVE,
+    salinity=SalinityKind.ABSOLUTE,
+    pressure_unit=PressureUnit.DBAR,
+    reference="Roquet et al. (2015), Ocean Modelling, 90, 29-43.",
+    description="55-term Boussinesq polynomial approx to TEOS-10 "
+                "(Oceananigans / SeawaterPolynomials.jl; MOM6 ROQUET_RHO family).",
+))

xeos/backends/_roquet_idealized.py

@@ -0,0 +1,81 @@
+"""Idealized second-order Roquet equations of state (Oceananigans).
+
+Roquet, F., G. Madec, L. Brodeau, J. Nycander (2015): "Defining a Simplified
+yet 'Realistic' Equation of State for Seawater." J. Phys. Oceanogr., 45, Table 3.
+(doi:10.1175/JPO-D-15-0080.1)
+
+These are the ``RoquetSeawaterPolynomial(:Linear | :Cabbeling | ...)`` options in
+SeawaterPolynomials.jl / Oceananigans.  Each is a second-order polynomial of the
+density anomaly in conservative temperature, absolute salinity, and geopotential
+height Z::
+
+    rho = rho_ref + R100*S + R010*T + R020*T^2 - R011*T*Z + R200*S^2
+                  - R101*S*Z + R110*S*T
+
+Coefficients ported verbatim from SeawaterPolynomials.jl.  Geopotential height is
+taken as ``Z = -p`` (sea pressure in dbar ~ depth in m, positive down), matching
+the convention of the 55-term ``teos10-poly55`` backend.  There is no standalone
+Python reference for these, so they are validated structurally (exact analytic
+derivatives checked against finite differences; literal check values).
+"""
+
+from ..conventions import TemperatureKind, SalinityKind, PressureUnit
+from ..registry import EOSBackend, register
+
+DEFAULT_REFERENCE_DENSITY = 1024.6  # kg m-3 (Oceananigans / Roquet default)
+
+# (R100, R010, R020, R011, R200, R101, R110) for each coefficient set.
+COEFFICIENTS = {
+    "roquet-linear": dict(R100=7.718e-1, R010=-1.775e-1),
+    "roquet-cabbeling": dict(R100=7.718e-1, R010=-0.844e-1, R020=-4.561e-3),
+    "roquet-cabbeling-thermobaricity": dict(
+        R100=7.718e-1, R010=-0.651e-1, R020=-5.027e-3, R011=-2.5681e-5),
+    "roquet-freezing": dict(
+        R100=7.718e-1, R010=-0.491e-1, R020=-5.027e-3, R011=-2.5681e-5),
+    "roquet-second-order": dict(
+        R100=8.078e-1, R010=0.182e-1, R020=-4.937e-3, R011=-2.4677e-5,
+        R200=-1.115e-4, R101=-8.241e-6, R110=-2.446e-3),
+    # Simplest-realistic (Roquet 2015 eq. 17): Cb=0.011, Th=2.5e-5, b0=0.77, T0=-4.5.
+    # The constant R000 = -Cb*T0^2/2 (~-0.11 kg m-3) is omitted (no dynamical effect),
+    # matching SeawaterPolynomials.jl; this offsets the absolute density by that constant.
+    "roquet-simplest-realistic": dict(
+        R100=0.77, R010=0.011 * -4.5, R020=-0.011 / 2, R011=-2.5e-5),
+}
+
+
+def make_roquet_idealized(eos_id, reference_density=DEFAULT_REFERENCE_DENSITY, **coeffs):
+    c = {k: 0.0 for k in ("R100", "R010", "R020", "R011", "R200", "R101", "R110")}
+    c.update(coeffs)
+    R100, R010, R020 = c["R100"], c["R010"], c["R020"]
+    R011, R200, R101, R110 = c["R011"], c["R200"], c["R101"], c["R110"]
+
+    def density(t, s, p):
+        z = -p  # geopotential height [m] ~ -(sea pressure in dbar)
+        anomaly = (R100 * s + R010 * t + R020 * t * t - R011 * t * z
+                   + R200 * s * s - R101 * s * z + R110 * s * t)
+        return reference_density + anomaly
+
+    def drho_dt(t, s, p):
+        z = -p
+        return R010 + 2.0 * R020 * t - R011 * z + R110 * s
+
+    def drho_ds(t, s, p):
+        z = -p
+        return R100 + 2.0 * R200 * s - R101 * z + R110 * t
+
+    return EOSBackend(
+        id=eos_id,
+        density=density,
+        drho_dt=drho_dt,
+        drho_ds=drho_ds,
+        temperature=TemperatureKind.CONSERVATIVE,
+        salinity=SalinityKind.ABSOLUTE,
+        pressure_unit=PressureUnit.DBAR,
+        reference="Roquet et al. (2015), J. Phys. Oceanogr., 45, Table 3.",
+        description=f"Idealized Roquet EOS '{eos_id.split('-', 1)[1]}' "
+                    f"(Oceananigans; rho_ref={reference_density}).",
+    )
+
+
+for _eos_id, _coeffs in COEFFICIENTS.items():
+    register(make_roquet_idealized(_eos_id, **_coeffs))