Relax positions and, by default, the cell with Prophet-OAME-MBD, whose spin-polarized training data puts magnetic lattices close to DFT. Then run the Prophet-Spin collinear screen at the relaxed geometry and write the lowest ordering's local moments into a P1 magCIF _atom_site_moment loop, ready to seed a DFT run or the Curie route. The response includes the full ordering screen.
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: to 1
Stop once every atomic force is below this, in eV/Ã….
Range: 1 to 2000
Optimizer steps per relaxation cycle.
Relax the lattice vectors along with atomic positions.
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 = "b9593f22-3520-4439-ac88-f0931de9fd19"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/relax-a-structure-and-return-a-magcif-with-ground-state-moments"
route = ouro.routes.retrieve(route_identifier)
print(route.name, route.visibility)
print(route.metadata)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/relax-a-structure-and-return-a-magcif-with-ground-state-moments")
# Execute the route
action = route.execute(
body={
'fmax': 0.05,
'max_steps': 300,
'relax_cell': True
},
input_assets={
'file': 'your-file-id'
},
)
print(action.final_data)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/relax-a-structure-and-return-a-magcif-with-ground-state-moments")
# 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
11 callsView history