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.
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 = "019f7111-6b38-7c6d-a962-ffacd979a94c"
# Retrieve dataset metadata
dataset = ouro.datasets.retrieve(dataset_id)
print(dataset.name, dataset.visibility)
print(dataset.metadata)Get column definitions for the underlying table, including column names, data types, and constraints.
| Column | Type |
|---|---|
| MAE_eV | real |
| MAE_easy_axis | text |
| Ms_A_per_m | real |
| all_cif_ids | text |
| band_gap_eV | real |
| compound | text |
| crystal_system | text |
| curie_action_id | uuidAction |
| curie_temp_K | real |
| elements | text |
| energy_above_hull_eV_per_atom | real |
| formula | text |
| hull_action_id | uuidAction |
| id | text |
| mae_action_id | uuidAction |
| magnetic_moment_uB | real |
| moments_action_id | uuidAction |
| n_calculations | integer |
| notes | text |
| phonon_action_id | uuidAction |
| phonon_stable | text |
| primary_cif_id | uuidAsset · file |
| relaxed_cif_id | uuidAsset · file |
| scf_total_energy_eV | real |
| source | text |
| space_group | text |
| team | text |
| thermodynamically_stable | text |
| unrelaxed_cif_id | uuidAsset · file |
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.
# 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)Comprehensive compilation of 4,324 rare-earth-free permanent magnet candidate compounds from all CIF files on the Ouro platform, joined with all existing non-ALIGNN route calculation results. Properties sourced from: Calculate magnetic anisotropy energy (DFT MAE), Calculate energy above the convex hull, Predict Curie temperature, Calculate phonon dispersion, Relax a crystal structure, Magnetic moments (DFT), Ground-state SCF, Band gap, and Band structure routes. ALIGNN predictions are excluded per requirement. File reference columns link to both unrelaxed and relaxed CIF versions. Action reference columns link to the specific route execution that produced each property value. Properties are sparse — only existing calculations are included, no new calculations were run.