stages-thermo 0.2.0

//! # stages-thermo — a staged-separation (distillation) column solver
//!
//! `stages-thermo` is a learning library **and** a fast steady-state column
//! engine for staged separations. It walks the full pedagogical ladder —
//! McCabe–Thiele → Ponchon–Savarit → Fenske–Underwood–Gilliland shortcut →
//! rigorous MESH (Wang–Henke, Burningham–Otto, Naphtali–Sandholm) — with every
//! method implemented from scratch and anchored to its textbook equations, and
//! it exposes a granular, batch-capable API ("numpy for distillation columns").
//!
//! The thermodynamics — K-values, enthalpies, and their derivatives — come
//! **entirely** from [`vle_thermo`](https://crates.io/crates/vle-thermo). This
//! crate adds no thermodynamics of its own; it is the first downstream consumer
//! of vle-thermo. See `PLAN.md` §1 for the full vision.
//!
//! ## Status
//!
//! Milestone 1 (column model + McCabe–Thiele). Implemented so far:
//!
//! - [`thermo`] — the adapter over vle-thermo 0.9.x: [`thermo::ThermoSystem`]
//!   with database-loaded components, φ-φ (Peng–Robinson) and γ-φ (van Laar)
//!   routes, bubble-point evaluation.
//! - [`column`] — the binary-sufficient column model
//!   ([`column::BinaryColumn`], [`column::Feed`], [`column::CondenserKind`]).
//! - [`binary`] — the equilibrium curve ([`binary::EquilibriumCurve`]) and
//!   the full McCabe–Thiele construction ([`binary::mccabe_thiele`]):
//!   operating lines, q-line, stage stepping, R_min with tangent-pinch
//!   detection, total reflux (N_min), N(R), Murphree efficiency.
//!
//! The remaining method modules (`shortcut`, `rigorous`, `numerics`) land
//! milestone by milestone per `ROADMAP.md`; the target module tree is
//! documented in `PLAN.md` §6.
//!
//! ## Design rule (PLAN §7)
//!
//! **Exactly one module talks to vle-thermo:** [`thermo`]. Everything else
//! consumes it through a provider interface, so a surrogate thermo model (the
//! inside-out inner loop, a stretch milestone) or a test mock can slot in
//! without touching the solvers.

pub mod binary;
pub mod column;
pub mod thermo;
pub mod types;

// Python bindings are compiled only with the `python` feature (enabled by
// maturin when building the wheel). `cargo add stages-thermo` gets a pure-Rust
// crate with no PyO3 in its dependency closure.
#[cfg(feature = "python")]
mod py_bindings;

/// Return this crate's version string (matches `Cargo.toml`).
///
/// Mirrors vle-thermo's `version()` so downstream Python can introspect which
/// engine build is loaded.
pub fn version() -> &'static str {
    env!("CARGO_PKG_VERSION")
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn version_is_semver_shaped() {
        let v = version();
        let parts: Vec<&str> = v.split('.').collect();
        assert!(parts.len() >= 3, "version {v} is not semver-shaped");
        assert!(parts[0].parse::<u64>().is_ok(), "major of {v} not numeric");
    }
}