Prophet-Spin evaluation. Provide collinear or non-collinear moments to score that magnetic state, or omit them to predict local moments from a ferromagnetic seed and score the result.
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.
Estimate local moments, then evaluate energy, forces, and stress at that configuration. Defaults to true when no moments are given.
Collinear moment for each atom, in μB, in CIF site order. When omitted, moments are predicted from a ferromagnetic seed.
One [mx, my, mz] vector per atom, in μB. Evaluated directly; moment prediction is collinear only.
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 = "9e09a76f-05aa-4c88-9e59-1f2cb1fdde08"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/predict-spin-dependent-energy-forces-and-stress"
route = ouro.routes.retrieve(route_identifier)
print(route.name, route.visibility)
print(route.metadata)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/predict-spin-dependent-energy-forces-and-stress")
# Execute the route
action = route.execute(
body={},
input_assets={
'file': 'your-file-id'
},
)
print(action.final_data)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/predict-spin-dependent-energy-forces-and-stress")
# 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')}")Execution
Usage
0 callsView history