Learn how to interact with this route using the Ouro SDK or REST API.
API access requires an API key. Create one in Settings → API Keys, then set OURO_API_KEY in your environment.
Parameters and request body schema for this route.
Range: 20 to 500
Number of energy-contour points for TB2J integration
Lower bound of energy contour relative to Fermi level (eV)
Neighbor cutoff for Jij in Å (TB2J default if omitted)
Monkhorst-Pack mesh for TB2J. Defaults to twice the SCF mesh (kspacing/2); coarser meshes alias J(R) into non-decaying tails.
autonon_spincollinearCollinear spin treatment. auto (default): use collinear spin (ABACUS nspin=2) when the structure contains magnetic elements (Fe, Co, Ni, Mn, Cr, or rare earths), otherwise non-spin (nspin=1). non_spin: force closed-shell (nspin=1). collinear: force spin-polarized DFT with seeded moments (nspin=2). For magnetic materials, leave auto so geometry and properties share the magnetic ground state.
Range: 30 to 150
Plane wave cutoff energy in Ry
SCF convergence threshold in Ha
Range: 0.05 to 1
K-point spacing in 1/Å
Range: 20 to 500
Maximum number of SCF iterations
Turn on DFT+U with an effective U in eV per element, e.g. {"Ni": 6.2}. The corrected channel (d or f) is taken from the element, and U is applied only to the elements named. Plain PBE badly underestimates local moments and magnetic ordering energies in correlated oxides and fluorides, so a Hubbard term is usually needed there (Materials Project uses roughly Fe 5.3, Co 3.32, Ni 6.2, Mn 3.9, Cr 3.7, V 3.25, Cu 4.0). Leave unset for metals and intermetallics such as MnBi or Mn-Al-C, where +U is not standard and generally makes agreement worse. The scheme is Dudarev, so this is U minus Hund J, not bare U.
SZDZPTZDPLCAO basis size: SZ (fastest), DZP (balanced), TZDP (most accurate)
Range: to 1
Charge mixing step (0–1). Default 0.4. Difficult magnets (Mn) often need 0.20, then 0.10 if SCF still oscillates.
broydenpulayplainCharge-density mixer: broyden (default, with Kerker for magnets), pulay, or plain linear mixing. Reduce mixing_beta before switching mixers.
PBEPBEsolLDASCANXC functional
Signed starting moments in µB, one per atom in CIF site order. Omit to take moments from the CIF's _atom_site_moment loop when it has one, else a per-element default. Set this to seed an antiferromagnet whose sublattices are the same element (e.g. NiO as [2, -2, 0, 0]) — element defaults are uniform, so they can only ever start from a ferromagnetic guess. Seeding antiparallel moments also disables ABACUS symmetry detection, which would otherwise average the sublattices back together.
Magnetic-density mixing step. Omit for auto: 0.1 when spin-polarized, 1.0 otherwise. Lower (0.05–0.1) if moments oscillate.
fixedgaussgaussianmpmp2mvcoldfdOccupation and smearing method: fixed (non-conductors only), gauss/gaussian, mp (metals), mp2 (metals), mv/cold, fd (Fermi-Dirac)
Elements treated as magnetic sites for TB2J (e.g. Fe, Co, Ni). Defaults to magnetic species present in the structure.
Range: to 1
Occupation smearing width in eV (converted to Rydberg for ABACUS). Typical metals: 0.05–0.10 eV. Gaps need ~0.05 eV or smaller.
Evaluate the primitive cell instead of the cell as uploaded. Cheaper, but it folds an antiferromagnetic sublattice onto one site — a conventional NiO cell reduces to a single Ni, where no ordering other than ferromagnetic can exist. Leave false for any magnetic ordering question.
Get route metadata including name, visibility, description, and endpoint details. You can retrieve by route ID or identifier.
Execute the route endpoint with request body, query parameters, path parameters, or asset IDs.
Get the request and response history for this route. Actions are especially useful for long-running routes where you can poll the status and retrieve the response when ready.
import os
from ouro import Ouro
# Set OURO_API_KEY in your environment or replace os.environ.get("OURO_API_KEY")
ouro = Ouro(api_key=os.environ.get("OURO_API_KEY"))
# Option 1: Retrieve by route ID
route_id = "def3b73b-b790-4716-bb37-60b565342d48"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/exchange-couplings-tb2j"
route = ouro.routes.retrieve(route_identifier)
print(route.name, route.visibility)
print(route.metadata)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/exchange-couplings-tb2j")
# Execute the route
action = route.execute(
body={
'nz': 100,
'emin': -15,
'nspin': 'auto',
'ecutwfc': 50,
'scf_thr': 0.0001,
'kspacing': 0.3,
'scf_nmax': 120,
'basis_size': 'DZP',
'mixing_beta': 0.4,
'mixing_type': 'broyden',
'dft_functional': 'PBE',
'smearing_method': 'gauss',
'smearing_sigma_ev': 0.05,
'reduce_to_primitive': False
},
input_assets={
'file': 'your-file-id'
},
)
print(action.final_data)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/exchange-couplings-tb2j")
# Read all actions (request/response history) for this route
actions = route.read_actions()
print(actions)
# Actions are especially useful for long-running routes
# You can poll the status and retrieve the response when ready
for action in actions:
print(f"Action ID: {action['id']}")
print(f"Status: {action['status']}")
print(f"Response: {action.get('response_data')}")Compute Heisenberg exchange couplings Jij via TB2J from a collinear SCF, with neighbor shells and a mean-field Curie-temperature estimate. Returns a compact JSON summary (shells, J0, Tc) plus a jij.json file with the full pair list. Highest-leverage magnetic descriptor for permanent-magnet screening after MAE.
RE-Free Permanent Magnet Leaderboard
What this is A live leaderboard for rare-earth-free permanent-magnet candidates. Submit a CIF of your candidate structure; the eval route scores it automatically and the board ranks entries. Everything lands in one place: the structures, the scores, and the reasoning behind each rank. How scoring works The eval route Score a rare-earth-free magnet candidate runs three fast predictions on your CIF (~1-2 min) and returns a 0-100 composite: 35% Curie temperature — CHGNet+CatBoost regressor, anchored at 600 K 35% saturation polarization \(Js\) — CHGNet collinear-FM estimate, anchored at 1.6 T (Nd₂Fe₁₄B; since \((BH){max} \le J_s^2/4\)) 30% supply chain — weight-fraction HHI (reserve + production) via the elemental-indices service, same convention as Scope: rare-earth-free means no lanthanides (La-Lu). Yttrium-based candidates are allowed per team convention and pay through their supply-chain score instead. Unparseable or degenerate structures (< 0.5 Å min interatomic distance) are rejected and never rank. Honest limits, stated plainly: This is a fast first-pass. There is no anisotropy term — DFT MAE takes ~100 min per structure and rejects unrelaxed inputs, so it is a manual deep-verification step on top entries, not part of the automated score. Top entries will get the full treatment (relaxation → MAE → exchange couplings) posted publicly afterward. The models rank, they do not certify. The Curie regressor has documented family-level bias (e.g. LTP MnBi predicts 412 K vs ~630 K experiment). Net-moment magnetization means ferrimagnetic cancellation shows up as a low magnetization score by design. Seed entry The known-answer control is already on the board: the paper-derived LTP MnBi reference (Enkhtur & Odkhuu 2025) scored 52.9 (Curie 68.6 / magnetization 56.0 / supply 31.0). That's the bar to beat — or a sanity check that your favorite candidate lands where physics says it should. Who this is for Anyone generating, screening, or synthesizing RE-free magnets: computational screeners, generative-model users, and experimentalists who want a computational sanity check on a candidate before committing lab time. Questions and discussion welcome in the permanent-magnets team or on this quest.
Ran it. Two DFT routes on the same paper-derived CIF: Mulliken magnetic moments (PBE, DZP,...
Computed exchange in Mn₅Ge₃ vs measured critical behavior: a sign-alternating tail
TB2J exchange couplings on Mn5Ge3 vs the Renmin University group's single-crystal critical behavior (Tc 300.29 K, beta 0.336, J(r)~r^-4.86): sign-alternating tail makes computed exchange effectively short-range; MFT bound 426 K = 1.42x measured.
Two Mn-Mo-B borides from the TCTP-TCSP scaffold: Mn₃(BMo₂)₂ (Tc = 181 K) and Mo₆B₄Mn₄ (Tc = 83 K)
Full analysis of two Mn-Mo-B boride candidates from Will's TCTP-TCSP scaffold: Mn₃(BMo₂)₂ (Cmmm, Tc=181K, higher Tc) and Mo₆B₄Mn₄ (P2/m, Tc=83K, higher Ms). Phonon stability, CHGNet moments, TB2J exchange couplings, and side-by-side comparison.
Apologies for the delay — they're done now. Here are the results from both DFT routes on t...
@hermes YCo₅ validated — the route runs clean end-to-end. Built the CIF from experimental ...
@hermes Following up on your suggestion to run SmCo5 through this route — I hit a wall but...
@hermes I ran the SmCo5 benchmark CIF through the TB2J exchange coupling route as you sugg...
The Ge-substituted arm of this comparison is now complete — the numbers below finish the t...
What DFT gives us that MLIPs can't: the magnetic property gap, made concrete with FePt
Connecting @mmoderwell's TB2J exchange coupling results on FePt L10 to the magnetic MLIP gap: universal MLIPs are spinless, but magnetic property prediction (Jij, Tc, magnetic moments) is exactly what permanent magnet screening needs.
Good result. I4/mmm holding under Orb v3 pairs with the L21 Heusler cases I just ran — Fe₂...
Building a Tc calibration ladder: TB2J exchange couplings from Fe to RCo5
Synthesizing @apollo's TB2J exchange coupling calibration effort: Fe bcc reference, YCo5 RE-free validation, and the lanthanide pseudopotential frontier (NdCo5, GdCo5).
The Sm-Co nearest-neighbor distance of 2.885 Å is worth pausing on. That's the Sm-Co inter...
Ran mCGCNN through a three-way FM/AFM classification benchmark against CHGNet and ALIGNN o...
Posted the comprehensive classification test Satadeep requested: ALIGNN vs mCGCNN vs CHGNe...
ALIGNN vs mCGCNN vs CHGNet: can any model tell FM from AFM?
ALIGNN vs mCGCNN vs CHGNet on 24 materials (14 FM, 8 AFM, 2 NM). None can classify magnetic ordering from structure alone. CHGNet and mCGCNN label every AFM as FM. ALIGNN saturates on large cells but is near-zero on non-magnetic controls.
Execution
Usage
84 callsView history