ferrotherm
Thermodynamic computing from Python: state a problem, get named values back.
The physics is open and old — Ising (1925), Glauber dynamics (1963), Gibbs sampling (Geman & Geman
1984) — and a "thermodynamic sampling unit" accelerates exactly these loops. This package binds the
ferrotherm Rust library through its C ABI: the solver is
zero-dependency Rust, deterministic by seed, verified against exact physics.
pip install ferrotherm
State a problem in the vocabulary of the problem
Not a QUBO matrix. Variables have names and domains, constraints say what they mean, and the answer comes back keyed by the names you used.
import ferrotherm as ft
p = ft.Problem()
a = p.categorical("a", 3)
b = p.categorical("b", 3)
p.not_equal(a, b)
p.maximize(3 * a.is_(1) + 4 * b.is_(2))
ans = p.solve(tries=32)
print(ans.values) # {'a': 1, 'b': 2}
print(ans.feasible) # True
A constraint can be soft — a price rather than a wall — and the answer reports what it cost:
import ferrotherm as ft
p = ft.Problem()
x = p.categorical("x", 3)
y = p.categorical("y", 3)
p.not_equal(x, y, soft=2.0) # breaking this costs 2.0 x amount squared
ans = p.solve(tries=32)
print(ans.soft_cost, ans.violated)
Or sample the physics directly
import ferrotherm as ft
s = ft.lattice2d(64, 1.0, beta=0.6) # a magnet below critical temperature
s.sweep(2000)
print(f"|M| = {abs(s.magnetization):.4f}") # 0.9736
print(f"Onsager = {ft.onsager(0.6):.4f}") # 0.9736 — the closed form, matched to 4 dp
That second line is the check that matters: Onsager's 1944 closed form for the infinite 2D lattice, and a 64x64 sampler reproducing it to four decimals. The size is not decoration — 16x16 over 500 sweeps gives 0.898 against 0.974, because a small lattice sampled briefly is not the thermodynamic limit. Verify against exact physics before opinions.
ft.ring, ft.z1_grid, ft.frustrated and ft.wishart build the other standard graphs, and
ft.Model takes an explicit edge list when you want to write the couplings yourself.
Every run carries its joules
The ledger is not an appendix. A sampler counts the work it did and prices it at Z1-class device figures, so the energy question is answerable rather than rhetorical. Note what is being priced: the modelled device, not the CPU this ran on.
import ferrotherm as ft
s = ft.lattice2d(64, 1.0, beta=0.6)
s.sweep(2000)
print(f"{s.node_updates} node updates -> {s.joules:.2e} J")
The library it binds
This package carries no solver of its own — it loads the shared library and calls it. In order:
FERROTHERM_LIB, if you set it. An explicit path always wins.- The copy shipped in the wheel.
target/release/of a checkout, for developing against a local build.
ft.library_path() tells you which one answered.
Apache-2.0. Source, the Rust crate and eight other bindings: https://github.com/dcharlot-physicalai-bmi/ferrotherm. From the Institute for Physical AI @ BMI.
1 maintainer
Metadata
1 maintainer
Release files for ferrotherm 0.38.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ferrotherm-0.38.0-py3-none-win_amd64.whl | Python 3 | none | Windows x86-64 | Details |
| ferrotherm-0.38.0-py3-none-manylinux_2_28_x86_64.whl | Python 3 | none | Linux glibc 2.28+ x86-64 | Details |
| ferrotherm-0.38.0-py3-none-macosx_11_0_arm64.whl | Python 3 | none | macOS 11.0+ ARM64 | Details |
Total release size: 1.9 MB
Release files / ferrotherm-0.38.0-py3-none-win_amd64.whl
| Download URL | ferrotherm-0.38.0-py3-none-win_amd64.whl |
|---|---|
| Size | 554.6 kB |
| Tags | Python 3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
2d6a360ae54325e8dae88fa3f1bca00351292eb0e3a818fc394f16c9bfa25908
|
|
BLAKE2b-256 checksum How to use checksums |
bde93a81530aefd6694a465c95dff67f4a9609f1c15de16a90f89cbc06d14540
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Sep 4, 2026.
Transparency logRelease files / ferrotherm-0.38.0-py3-none-manylinux_2_28_x86_64.whl
| Download URL | ferrotherm-0.38.0-py3-none-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 715.8 kB |
| Tags | Linux glibc 2.28+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
27a60ca34ed288b8783b5f6e8b716cb5e6627727f82bf3d7e8f8ab3c46be60fc
|
|
BLAKE2b-256 checksum How to use checksums |
f25c7f74e3ed878f11f34384199f3fd7372c429528e9a72f7b680870bf9ebddc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Sep 4, 2026.
Transparency logRelease files / ferrotherm-0.38.0-py3-none-macosx_11_0_arm64.whl
| Download URL | ferrotherm-0.38.0-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 622.5 kB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
4011263037f3bf2b275c4b3126221a369b8b47c0d8745cc9c28a8830868e3e30
|
|
BLAKE2b-256 checksum How to use checksums |
53755eb18b2835b6d26c7a91314e27424ab3e7b98764e0f8795b775a5d3feb7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Sep 4, 2026.
Transparency log
