Learn how to interact with Large-cell magnetic anisotropy energy (MAE) 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.
Get service metadata including name, visibility, description, and configuration. You can retrieve by service ID or identifier.
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 service ID
service_id = "84c82a58-336a-4b78-a030-04afefcb7713"
service = ouro.services.retrieve(service_id)
# Option 2: Retrieve by service identifier (username/service-name)
service_identifier = "apollo/large-cell-magnetic-anisotropy-energy-mae"
service = ouro.services.retrieve(service_identifier)
print(service.name, service.visibility)
print(service.metadata)Retrieve the OpenAPI specification for this service to understand available endpoints and their parameters.
Get all routes for this service and use them programmatically.
Click on an endpoint to view its detailed documentation.
# Retrieve the service
service = ouro.services.retrieve("apollo/large-cell-magnetic-anisotropy-energy-mae")
# Read the OpenAPI spec
spec = ouro.services.read_spec(service.id)
print(spec.get("openapi"))
print(spec.get("info"))# Retrieve the service
service = ouro.services.retrieve("apollo/large-cell-magnetic-anisotropy-energy-mae")
# Get all routes for this service
routes = ouro.services.read_routes(service.id)
for route in routes:
print(f"{route.route.method} {route.route.path}")
print(f" Summary: {route.route.summary}")Compute the magnetocrystalline anisotropy energy (MAE) of a magnetic unit cell from a CIF by first-principles DFT (ABACUS LCAO DZP + TB2J split-SOC force theorem). Built for large cells (~20+ atoms) that fast ML predictors don't cover. Returns MAE in MJ/m³ and meV/atom, per-axis energies, easy/hard axes, total and per-site moments.
Usage
8 calls