Learn how to interact with this dataset 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 dataset metadata including name, visibility, description, and other asset properties.
Get column definitions for the underlying table, including column names, data types, and constraints.
| Column | Type |
|---|---|
| compound | text |
| easy_axis | text |
| exp_tc_k | integer |
| exp_tc_known | text |
| expected_order | text |
| file_id | text |
| hard_axis | text |
| id | uuid |
| kappa | real |
| mae_action_id | text |
| mae_ev | real |
| mae_mev_per_atom | real |
| mae_mj_per_m3 | real |
| mae_pass_0.5 | text |
| ms_a_per_m | real |
| total_moment_ub | real |
Fetch the dataset's rows. Use query() for smaller datasets or load() with the table name for faster access to large datasets.
Update dataset metadata (visibility, description, etc.) and optionally write new rows to the table. Writing new data will replace the existing data in the table. Requires write or admin permission on the dataset.
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"))
dataset_id = "019ebe59-ffb6-7132-b6eb-cf5eb455274b"
# Retrieve dataset metadata
dataset = ouro.datasets.retrieve(dataset_id)
print(dataset.name, dataset.visibility)
print(dataset.metadata)# Get column definitions for the underlying table
columns = ouro.datasets.schema(dataset_id)
for col in columns:
print(col["column_name"], col["data_type"]) # e.g., age integer, name text# Option 1: All rows as a Pandas DataFrame
df = ouro.datasets.query(dataset_id)
print(df.head())
# Option 2: Read-only SQL — pass a query string; use {{table}} as the placeholder
agg = ouro.datasets.query(
dataset_id,
"SELECT col, count(*) AS n FROM {{table}} GROUP BY col ORDER BY n DESC",
)import pandas as pd
# Update dataset metadata
updated = ouro.datasets.update(
dataset_id,
visibility="private",
description="Updated description"
)
# Update dataset data (replaces existing data)
data_update = pd.DataFrame([
{"name": "Charlie", "age": 33},
{"name": "Diana", "age": 28},
])
updated = ouro.datasets.update(dataset_id, data=data_update)DFT MAE on the two Cu2Sb-type P4/nmm Gate 2 candidates. Mn2Sb FAILS 0.163 MJ/m^3 (c-axis easy, Ms 844 kA/m); KMnP PASSES 0.513 MJ/m^3 (in-plane easy, Ms 452 kA/m). MAE ranking inverts Curie T ranking.
DFT MAE gate on the two Cu2Sb-type P4/nmm candidates from the Gate 2 sweep. Mn2Sb FAILS at 0.163 MJ/m^3; KMnP just PASSES at 0.513 MJ/m^3. MAE ranking inverts Curie T ranking. Cu2Sb-type line closed at the screening level.