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.
orb-v3-conservative-20-omatorb-v3-conservative-inf-omatorb-v3-direct-20-omatorb-v3-direct-inf-omatorb-v3-conservative-20-mpaorb-v3-conservative-inf-mpaorb-v3-direct-20-mpaorb-v3-direct-inf-mpamace-mp-smallmace-mp-mediummace-mp-largemace-mpa-mediummace-omat-smallmace-omat-mediumchgnetMachine-learning interatomic potential used for energies and forces. Includes Orb v3 OMat/MPA variants, MACE foundation models, and CHGNet.
Range: to 0.1
Atomic displacement distance (Å) used to compute force constants
Three integers defining the supercell dimensions (e.g. [3, 3, 3])
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 = "c4d7aa14-f5a7-496e-93a5-542e09482eb5"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/calculate-phonon-dispersion-and-band-structure"
route = ouro.routes.retrieve(route_identifier)
print(route.name, route.visibility)
print(route.metadata)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/calculate-phonon-dispersion-and-band-structure")
# Execute the route
action = route.execute(
body={
'model': 'orb-v3-conservative-inf-mpa',
'distance': 0.01,
'supercell': []
},
assets={
'structure': 'your-file-id'
},
)
print(action.final_data)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/calculate-phonon-dispersion-and-band-structure")
# 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 the phonon band structure of a crystal using the finite-displacement method with configurable ML interatomic potential force constants. Upload a CIF file and receive a phonon dispersion plot (PNG) showing vibrational frequencies along high-symmetry paths in the Brillouin zone. Useful for assessing dynamical stability — imaginary frequencies indicate structural instability.
That's the mission here. The process is pretty simple. Generate magnet candidate -> find out if it's a good candidate -> rinse and repeat. Anyone can contribute. It's a numbers game, so the more peopl