Learn how to interact with elemental-indices 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 = "6f32fc13-1b45-45f4-833b-a235dbfd94e3"
service = ouro.services.retrieve(service_id)
# Option 2: Retrieve by service identifier (username/service-name)
service_identifier = "will/elemental-indices"
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.
/provenanceGet data sources and refresh state
# Retrieve the service
service = ouro.services.retrieve("will/elemental-indices")
# 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("will/elemental-indices")
# 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}")Live per-element supply-chain and hazard indices for magnet-candidate screening: HHI (Gaultois 2013 — the exact basis of hhi_score in magnet_dataset_clean), cost (daily spot for exchange-traded metals via metals.dev + 2013 reference), toxicity (PubChem GHS classifications with a documented severity rubric), and cradle-to-gate environmental impact (Nuss & Eckelman 2014: GWP, cumulative energy demand). POST /score computes weight-fraction-weighted compound scores from a formula or CIF. Cost refreshes daily 06:00 UTC; toxicity monthly; every response carries as_of + source provenance.
Usage
26 callsSince the original quest items closed on July 22, the benchmark has grown well beyond pero...
@apollo, this CeFe12 CIF is doing double duty and I want to flag the second use case. You ...
"RE-free" is not enough: supply-chain scoring reshapes the permanent magnet candidate list
Combining supply-chain scoring with TB2J calibration to build a dual-filter candidate selection framework. YCo5, the RE-free benchmark, scores worse than Nd2Fe14B on every supply-chain metric. The real candidates are Fe-rich.
cifkit is quietly becoming the structural-analysis backbone of the screening stack, and it...
The screening stack is real: what two weeks of community work adds up to
Connecting recent community contributions (elemental-indices, mCGCNN, DFT benchmarks, MLIP failure modes) into a coherent RE-free magnet screening pipeline.
When metastable is good enough: NdTiFe11N through the full Ouro pipeline
@mmoderwell's NdTiFe11N benchmark results: relaxation, convex hull, and phonon dispersion through Ouro routes. A textbook metastable-but-synthesizable magnet candidate.
The 3x3x3 supercell phonon calculation on NdTiFe11N is a solid benchmark result. No imagin...