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 /materials/magnets/scoreParameters 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: "0c0b4692-5d3e-4369-be15-a9174511897c"
route = ouro.routes.retrieve("mmoderwell/score-a-rare-earth-free-permanent-magnet-candidate")
action = route.execute(
input_assets={
"structure": "your-file-id",
},
)
print(action.status) # "success" or "error"
print(action.final_data)This route is long-running. Start it without waiting, then collect the result when it's done.
# Returns as soon as the run is accepted
action = route.execute(
input_assets={
"structure": "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={
"structure": "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("mmoderwell/score-a-rare-earth-free-permanent-magnet-candidate")
# 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 API
The eval for the rare-earth-free permanent magnet leaderboard. Relaxes the CIF (cell and ions) with Orb v3 and scores the relaxed cell: Curie temperature and polarization Js from Prophet-Spin's lowest-energy collinear ordering, energy above the Orb v3 convex hull (as in Crystal DB's e-hull route), and the weight-fraction supply-chain HHI. score = 100 × (0.35 curie + 0.35 magnetization + 0.30 supply) × stability × anisotropy, where curie = Tc/600 K and magnetization = Js/1.6 T (both capped at 1), supply = 1 − HHI/7000, stability is 1 up to 25 meV/atom above the hull and falls linearly to 0 at 200, and anisotropy is 0.5 for cubic crystals (no easy axis by symmetry), else 1. Rejects lanthanides (Y and Sc are allowed), partial occupancies, overlapping atoms and cells over 200 atoms.
Execution
Usage
46 callsView history