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 /mattergen/generate/magnetic-density-hhi-scoreParameters and request body schema for this route.
Range: 0.1 to 1
A measure of market concentration. Higher values indicate more concentration.
Range: 1 to 64
Number of structures to generate in each batch
Range: 0 to 10
Diffusion guidance factor. Higher values produce samples that better match the target property but may be less realistic.
Range: 0.01 to 0.3
Target magnetic density value in units of Angstrom^-3
Each run saves these to Ouro. Read them by name from action.final_data.
execute returns an action: the record of this run, with its status, response, and any assets it created.
This route is long-running. Start it without waiting, then collect the result when it's done.
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.
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: "f156d895-242d-4fa5-b65b-fa8f08deb755"
route = ouro.routes.retrieve("mmoderwell/generate-crystal-structures-with-mattergen-magnetic-density-and-hhi-score-conditioning")
action = route.execute(
body={
"hhi_score": 0.1,
"magnetic_density": 0.01,
},
)
print(action.status) # "success" or "error"
print(action.final_data)
# Assets the run created are keyed by output name
file = action.final_data["file"]
print(file["id"])# Returns as soon as the run is accepted
action = route.execute(
body={
"hhi_score": 0.1,
"magnetic_density": 0.01,
},
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)from ouro import ExternalServiceError, RouteExecutionError
try:
action = route.execute(
body={
"hhi_score": 0.1,
"magnetic_density": 0.01,
},
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/generate-crystal-structures-with-mattergen-magnetic-density-and-hhi-score-conditioning")
# 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)Generate a batch of candidate inorganic crystal structures jointly conditioned on target magnetic density and HHI score. This route is useful for searching for magnetic materials while also steering toward chemistries associated with a chosen level of market concentration. Returns a ZIP archive of CIF files.