How to run this route from Python with the Ouro SDK.
API access requires an API key. Create one in Settings → API Keys, then set OURO_API_KEY in your environment. Install the SDK with pip install ouro-py.
POST /magnetism/magnetic-saturationParameters and request body schema for this route.
This route accepts no parameters or request body.
Pass the ID of an Ouro asset for each of these in input_assets. Ouro loads the asset and sends it to the route.
execute returns an action: the record of this run, with its status, response, and any assets it created.
import os
from ouro import Ouro
ouro = Ouro(api_key=os.environ.get("OURO_API_KEY"))
# The ID also works, and stays the same if the route is renamed: "d1fdf6d1-2b35-47af-956f-1b83c2fca036"
route = ouro.routes.retrieve("hermes/estimate-magnetic-moments-and-ms-from-a-cif")
action = route.execute(
input_assets={
"file": "your-file-id",
},
)
print(action.status) # "success" or "error"
print(action.final_data)To avoid blocking on a slow run, start it without waiting and collect the result later.
# Returns as soon as the run is accepted
action = route.execute(
input_assets={
"file": "your-file-id",
},
wait=False,
)
print(action.id, action.status)
# Later, even from another process
action = ouro.routes.poll_action(str(action.id), poll_interval=5, timeout=1800)
print(action.final_data)By default a failed run comes back as an action with status error. Pass raise_on_error=True to raise an exception instead.
Every run is saved as an action. List yours, or read the logs of a single run. See the Python SDK reference for everything an action carries.
from ouro import ExternalServiceError, RouteExecutionError
try:
action = route.execute(
input_assets={
"file": "your-file-id",
},
raise_on_error=True,
)
except ExternalServiceError as exc:
# The API behind this route failed
print(exc.status_code, exc.retryable)
except RouteExecutionError as exc:
print(exc.action_id, exc.status, exc.response)
except TimeoutError as exc:
# Still running on Ouro; pick it up again later
action = ouro.routes.poll_action(exc.action_id, timeout=None)route = ouro.routes.retrieve("hermes/estimate-magnetic-moments-and-ms-from-a-cif")
# Your runs of this route
actions = route.read_actions()
for action in actions:
print(action.id, action.status, action.created_at)
# One run and its logs
action = ouro.routes.retrieve_action("your-action-id")
for entry in action.read_logs(chronological=True):
print(entry.level, entry.message)Part of service
Materials Science API
Infer per-site magnetic moments with CHGNet and estimate saturation magnetization assuming collinear ferromagnetic alignment of those local moments.
Outputs
Site moments (µB) with element labels
Net vs absolute cell/formula-unit moments (near-zero net + large absolute ⇒ AFM/FiM-like cancellation)
Estimated Ms / Js in A/m, T (µ₀ Ms), emu/cm³, emu/g, and µB/ų
This is a fast local-moment screen, not a magnetic-ordering solver. Pair with Curie-temperature prediction for a fuller magnet dossier.
Execution
Usage
5200 callsView history