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. The default matches the 100 Ry the orbitals are generated for; at 50 Ry L1_0 FePt MAE comes out 50% high.
SCF convergence threshold on the charge-density residual (ABACUS scf_thr; not an energy). The default suits screening; ABACUS's own LCAO default is 1e-7. Tighten to 1e-6 or below when comparing small energy differences such as ordering margins.
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). Setting this also softens the SCF defaults to mixing_beta 0.2 and scf_nmax 300, which correlated oxides need; an explicit value for either still wins. 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 = "29fd80eb-7cf5-4895-a349-4e9864407567"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/curie-temperature-tc"
route = ouro.routes.retrieve(route_identifier)
print(route.name, route.visibility)
print(route.metadata)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/curie-temperature-tc")
# Execute the route
action = route.execute(
body={
'nz': 100,
'emin': -15,
'nspin': 'auto',
'ecutwfc': 100,
'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/curie-temperature-tc")
# 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')}")Predict the magnetic ordering temperature (Curie, or Néel for antiferromagnets) from classical Heisenberg Monte Carlo on TB2J exchange couplings. Tc_K is the susceptibility peak in a supercell twice the longest kept coupling wide; Tc_mean_field_K is the mean-field upper bound. Also returns the magnetization curve and reference_ordering_overlap: near 1 when the couplings favor the SCF's own collinear order. Below 0.5 the response carries a warning: Tc belongs to a different ordering, because either the SCF started from the wrong one (check with /dft/magnetic/ordering) or a rigid-spin Heisenberg model cannot describe the magnet (e.g. L1₀ FePt, whose ferromagnetism is mediated by induced Pt moments). Shares its calculation with /dft/magnetic/exchange at the same settings. Key descriptor for permanent-magnet screening alongside MAE.
Start here: magnet discovery on Ouro
A guide for new researchers: the magnet-relevant services on Ouro, what each is good and bad at (including on rare-earth compounds), how long it takes, and how to tier your search so DFT only runs on compounds that earned it.
Ouro DFT now predicts Curie temperatures, and MAE runs at a converged cutoff
A dedicated Tc route on Monte Carlo exchange, a 100 Ry default that fixes a 50% MAE overshoot, faster magnetic paths, and validation on Fe, NiO and FePt.
Execution
Usage
0 callsView history