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 |
|---|---|
| all_cif_ids | text |
| cif_file_id | uuidAsset · file |
| compound | text |
| crystal_system | text |
| curie_temp_K | text |
| elements | text |
| formula | text |
| hull_distance_eV_per_atom | text |
| id | text |
| mae_eV_per_formula | text |
| magnetic_moment_uB | text |
| n_cif_files | integer |
| notes | text |
| source | text |
| space_group | text |
| stability | text |
| team | text |
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 = "019f68b5-c483-732e-9734-806846eba9be"
# 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)Comprehensive compilation of every RE-free magnetic compound found on Ouro, built using ouro-py files.search() across all 13,501 CIF files on the platform. 4,319 unique formulas from 12,291 matching CIF files. Parsed with pymatgen for formula, space group, and composition. Filtered: at least one ferromagnetic element (Fe,Co,Ni,Mn,Cr), no rare earths (Sc,Y,lanthanides).