Skip to main content

stages-thermo

A staged-separation (distillation) learning library and fast steady-state column solver, built on vle-thermo.

import stages — walk the full pedagogical ladder of column methods (McCabe–Thiele → Ponchon–Savarit → Fenske–Underwood–Gilliland shortcut → rigorous MESH: bubble-point, sum-rates, inside-out, full Newton), each implemented from scratch and anchored to its textbook equations, with a granular, batch-capable API ("numpy for distillation columns"). All thermodynamics come from vle-thermo; this package adds none of its own.

The ladder's terminal target is an atmospheric crude distillation unit — hundreds of pseudocomponents, pumparounds, steam-stripped side strippers, and products specified on D86 95 % points and gaps rather than mole-fraction purity.

pip install stages-thermo           # import name is `stages`
pip install "stages-thermo[plot]"   # + matplotlib for the staircase diagrams

Status: 0.5.x ships the first four rungs of the ladder — including the first rigorous MESH solver, the Wang–Henke bubble-point method (Milestone 6): wang_henke solves multi-feed columns with side draws under the classic reflux-ratio + distillate-rate specs on any thermo provider (Peng–Robinson, the new SRK route, NRTL/van-Laar γ-φ, or the ideal teaching mock), with trace mode for the convergence machinery, and is validated against Seader–Henley–Roper 4th-ed Examples 10.1 (exact) and 10.8 (0.04 K agreement with the book's CHEMCAD/SRK run). Below it sit the binary McCabe–Thiele (Milestone 1) and Ponchon–Savarit (Milestone 2) layers and the multicomponent FUG shortcut (Milestone 3): equilibrium and enthalpy–composition (H–x–y) curves from real thermodynamics, minimum reflux by geometric pinch detection (tangent pinches included), stage stepping with Murphree efficiency, total reflux, N(R), the energy-exact difference-point construction (with condenser/reboiler duties), the NRTL γ-φ model, per-phase enthalpies, Fenske–Underwood–Gilliland + Kirkbride + Winn with relative volatilities computed from vle-thermo K-values (fug), the multicomponent K-value / dew-point / flash surface on ThermoSystem, and the diagram plots (staircase, H–x–y, Gilliland). Milestone 5 added the MESH infrastructure every rigorous solver shares: Column (the multicomponent column as a stage graph — multi-feed incl. vapor-only, side draws, duties, pressure profiles), Profiles (the state/result object), mesh_residuals (through a ThermoSystem or the textbook IdealProvider), Spec incl. the general Spec.stream_property, seed_profiles / seed_from_fug, the thomas / thomas_component_balance kernels, SolveReport and ColumnSolution. The remaining solvers land milestone by milestone — see the repo's ROADMAP.md. 1.0 ships inside-out (Boston–Britt/Russell) as the flagship rigorous solver alongside Wang–Henke and sum-rates; the crude-column capability follows at 2.0, and Naphtali–Sandholm (the specialist for strongly nonideal columns) at 2.1. The API may still move before 1.0.

import stages

# Real thermodynamics from vle-thermo: Peng–Robinson benzene–toluene at 1 atm
# (light component first; units K / kPa absolute / mole fractions).
sys = stages.ThermoSystem.peng_robinson(["benzene", "toluene"])
curve = stages.EquilibriumCurve.from_thermo(sys, 101.325)

# Minimum reflux by pinch detection — tangent pinches included …
r = stages.rmin(curve, x_distillate=0.95, x_bottoms=0.05, z_feed=0.50, q=1.0)

# … then the full construction. Rich result objects, never bare numbers:
design = stages.mccabe_thiele(curve, 0.95, 0.05, 0.50, reflux=1.5 * r.r_min)
print(f"N = {design.n_stages:.2f} stages, feed stage {design.feed_stage}, "
      f"R_min = {r.r_min:.3f}")

design.stages          # every (x, y) stage corner
design.staircase       # the full polyline, ready to plot
design.rectifying      # operating lines as slope/intercept
r.pinch, r.tangent     # where the pinch sits, and whether it's a tangent pinch

# The staircase diagram (requires the [plot] extra):
# from stages import plotting
# plotting.plot_mccabe_thiele(design, curve, show_rmin=True)

Strongly non-ideal systems go through the γ-φ route — the same construction, different thermodynamics:

# van Laar methanol–water (the system validated in vle's Chapter IV notebooks).
mw = stages.ThermoSystem.van_laar(["methanol", "water"], 0.5853, 0.3458)
curve_mw = stages.EquilibriumCurve.from_thermo(mw, 101.325)

Rung 2 — Ponchon–Savarit — closes the energy balance on the enthalpy–composition (H–x–y) diagram, so it also returns the condenser and reboiler duties (which McCabe–Thiele cannot):

# H–x–y curve: saturated-liquid and -vapor enthalpies alongside y*(x).
ec = stages.EnthalpyCurve.from_thermo(sys, 101.325)
ps = stages.ponchon_savarit(ec, x_distillate=0.95, x_bottoms=0.05,
                            z_feed=0.50, reflux=1.5)
print(f"N = {ps.n_stages:.2f} stages, feed stage {ps.feed_stage}")
print(f"Q_C/F = {ps.q_condenser:,.0f}, Q_R/F = {ps.q_reboiler:,.0f} kJ/kmol feed")
ps.delta_d, ps.delta_b   # the two difference points (poles), (x, H) in kJ/kmol

# NRTL for strongly non-ideal aqueous-organic systems (a12/a21 in kJ/kmol):
aw = stages.ThermoSystem.nrtl(["ammonia", "water"], a12=-1800.0, a21=-1200.0, alpha=0.2)
# from stages import plotting; plotting.plot_ponchon_savarit(ps, ec)

Rung 3 — the FUG shortcut — is multicomponent. Every relative volatility comes from vle-thermo K-values at the two ends of the column (the "FUG(K)" form that a simulator uses to seed its rigorous solver), refined to self-consistency; each rung is also callable on its own (fenske_n_min, underwood_roots, gilliland_stages, kirkbride_split, winn_fit, …):

# A depropanizer: propane (LK) / isobutane (HK), 98 % key recoveries, R = 1.3 R_min.
c3 = stages.ThermoSystem.peng_robinson(["ethane", "propane", "isobutane", "n-butane", "n-pentane"])
fug = stages.fug(c3, 1500.0, feed=[5, 40, 20, 25, 10], light_key=1, heavy_key=2,
                 lk_recovery=0.98, hk_recovery=0.98, q=1.0, reflux_factor=1.3)
print(fug)   # FugResult(N_min=12.95, R_min=1.885, R=2.450, N=26.47, feed_stage=15, ...)
fug.underwood_roots, fug.n_min_winn, fug.d, fug.x_d, fug.t_top   # every intermediate
# from stages import plotting; plotting.plot_gilliland(fug)

Milestone 5's infrastructure is callable on its own — the multicomponent column as a stage graph, the shortcut-seeded starting state, and the MESH residuals of any state through the provider boundary:

import math

# The depropanizer above as a column: total condenser at stage 0, partial
# reboiler last, the feed on the FUG feed stage (0-based indices).
n = math.ceil(fug.n_stages) + 1
col = stages.Column.simple(n, 5, "total", "partial", 1500.0)
col = col.with_feed(fug.feed_stage, [5, 40, 20, 25, 10], "saturated_liquid")
col.degrees_of_freedom          # 2 — e.g. Spec.reflux_ratio + Spec.product_rate

# Seed: linear T, constant-molal-overflow flows, x_D → x_B blend, Kb, α, S.
prof = stages.seed_from_fug(col, c3, fug)
prof.t, prof.l, prof.v, prof.s   # flat per-stage arrays; prof.x_stage(j) per stage

# The MESH residuals of that state (K, H_L, H_V are written back into prof).
res = stages.mesh_residuals(col, c3, prof)
print(res)   # MeshResiduals(max|M|=..., max|E|=..., max|S|=..., max|H|=...)

# Specifications reduce to residual rows — including the general variant.
specs = [stages.Spec.reflux_ratio(fug.reflux),
         stages.Spec.stream_property("distillate", lambda s: s["flows"][1], 39.2, name="propane in D")]
stages.validate_specs(col, specs)
stages.spec_residuals(col, prof, specs)

And Milestone 6 drives those residuals to zero — the Wang–Henke bubble-point solver, here on the five-stage column of Seader–Henley–Roper 4th-ed Examples 10.1/10.8 (SRK, 100 psia = 689.476 kPa, R = 2, D = 50 kmol/h):

srk = stages.ThermoSystem.soave_redlich_kwong(["propane", "n-butane", "n-pentane"])
col = stages.Column.simple(5, 3, "total", "partial", 689.476)
col = col.with_feed(2, [30.0, 30.0, 40.0], "saturated_liquid")
seed = stages.seed_profiles(col, srk, t_top=291.5, t_bottom=347.0,
                            reflux_ratio=2.0, distillate_rate=50.0,
                            x_top=[0.55, 0.40, 0.05], x_bottom=[0.02, 0.25, 0.73])
sol = stages.wang_henke(col, srk, 2.0, 50.0, seed, tol_sum_dt2=1e-8, trace=True)
sol.report.converged                 # True (18 iterations)
sol.report.outer.residual_norms      # τ = Σ(ΔT)² per iteration [K²]
sol.report.final_residual            # rigorous scaled MESH ∞-norm at the answer
sol.profiles.t                       # converged stage temperatures [K]
sol.condenser_duty, sol.reboiler_duty
stages.product_stream(col, sol.profiles, "bottoms")["flows"]
# → [0.955, 12.357, 36.687] kmol/h — the book's CHEMCAD run prints
#   [0.955, 12.363, 36.683]; stage temperatures agree to 0.04 K.

wang_henke_composition_step exposes the tridiagonal step alone — the exact kernel the inside-out inner loop (M11) will iterate on.

The executable learning path lives in the repo's notebooks/ — 01-mccabe-thiele.ipynb, 02-ponchon-savarit.ipynb and 03-shortcut-design.ipynb design benzene–toluene, methanol–water, acetone–water and ammonia–water binaries (the last on a reference chart digitized from the Pátek–Klomfar correlation) and a C2–C5 depropanizer end-to-end, and 04-mesh-and-bubble-point.ipynb opens the rigorous machinery — the tridiagonal structure, the convergence history, the MESH residuals — with exercises throughout.

The native core is a Rust crate (stages-thermo on crates.io) with PyO3 bindings; wheels are abi3 (cp310-abi3-*), so one wheel per (OS, arch) covers CPython 3.10+.

License

MIT © Miguel Roberto Jackson Ugueto

Metadata

Release files for stages-thermo 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for stages-thermo 0.5.0
File Size Uploaded Provenance Actions
stages_thermo-0.5.0.tar.gz 163.5 kB With provenance Details for stages_thermo-0.5.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for stages-thermo 0.5.0
File Actions
stages_thermo-0.5.0-cp310-abi3-win_amd64.whl CPython 3.10 abi3 Windows x86-64 Details for stages_thermo-0.5.0-cp310-abi3-win_amd64.whl
stages_thermo-0.5.0-cp310-abi3-manylinux_2_28_x86_64.whl CPython 3.10 abi3 Linux glibc 2.28+ x86-64 Details for stages_thermo-0.5.0-cp310-abi3-manylinux_2_28_x86_64.whl
stages_thermo-0.5.0-cp310-abi3-manylinux_2_28_aarch64.whl CPython 3.10 abi3 Linux glibc 2.28+ ARM64 Details for stages_thermo-0.5.0-cp310-abi3-manylinux_2_28_aarch64.whl
stages_thermo-0.5.0-cp310-abi3-macosx_11_0_arm64.whl CPython 3.10 abi3 macOS 11.0+ ARM64 Details for stages_thermo-0.5.0-cp310-abi3-macosx_11_0_arm64.whl

Total release size: 2.8 MB

Release files / stages_thermo-0.5.0.tar.gz

Download URL stages_thermo-0.5.0.tar.gz
Size 163.5 kB
Tags Source
SHA-256 checksum
How to use checksums
33f95db4aa86e77e59b3a731c598ac7c1374f7c99978deba4b89440eb1798a92
BLAKE2b-256 checksum
How to use checksums
572600499c0f41468a174af99960b717e2113f6da7f64629862bf48e041affb9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.

Transparency log

Release files / stages_thermo-0.5.0-cp310-abi3-win_amd64.whl

Download URL stages_thermo-0.5.0-cp310-abi3-win_amd64.whl
Size 624.3 kB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
cc498bb40dbfab1e6c3e36556839ca48cc0ee59358ae54812d315b72731a6efd
BLAKE2b-256 checksum
How to use checksums
cdf195412f93aa618b3e9980f0054caf23ced439bb62c7724dd74f6bc4ea6fb4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.

Transparency log

Release files / stages_thermo-0.5.0-cp310-abi3-manylinux_2_28_x86_64.whl

Download URL stages_thermo-0.5.0-cp310-abi3-manylinux_2_28_x86_64.whl
Size 717.0 kB
Tags CPython 3.10 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
205e72b7b3ea919eca463304d054c95d5d15581ac1d3bacc1b2c7d4133fd5a7f
BLAKE2b-256 checksum
How to use checksums
01fb29b841c7ec0e2473d2bb67efd2cfc4e0244d6323214cee4fc1d1733cef84
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.

Transparency log

Release files / stages_thermo-0.5.0-cp310-abi3-manylinux_2_28_aarch64.whl

Download URL stages_thermo-0.5.0-cp310-abi3-manylinux_2_28_aarch64.whl
Size 687.7 kB
Tags CPython 3.10 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
62450c8b7f002c83b7884e72ec87a9e2aa9da1a920a8612c9b3b34c4227e3d52
BLAKE2b-256 checksum
How to use checksums
cdc65636e533d016cb81397462016e63ec4f2f5e31b11f11734fa8af31490d78
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.

Transparency log

Release files / stages_thermo-0.5.0-cp310-abi3-macosx_11_0_arm64.whl

Download URL stages_thermo-0.5.0-cp310-abi3-macosx_11_0_arm64.whl
Size 656.3 kB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
da12160e10450c32b8275ecb3bd9e0498f1526c27abcaadfa81dca39083ed3a1
BLAKE2b-256 checksum
How to use checksums
b52c69fa97055d9de1b02d9dedf96d7706df8b9cb4df18935b62b6fcfdd699e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.

Transparency log

Security for stages-thermo 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 5 files in this release have been uploaded with provenance metadata.

Select from 5 files

Attestation for stages_thermo-0.5.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page