Python SDK

​

Features

• Upload files - Send RHEED videos, images, XPS, XRD, photoluminescence, Raman, ellipsometry, and metrology data for automated analysis
• Search the catalogue - Query your data with filters for type, status, date ranges, and keywords
• Retrieve results - Access time series data, extracted frames, pattern graphs, and processed files
• Query RHEED features and masks - Pull the full low-level feature set and per-frame segmentation masks
• Compare growths - Run similarity queries over embedding vectors and track similarity trajectories
• Organize by sample and project - Group data across runs and align timeseries from multiple instruments
• Stream data - Push RHEED frames and instrument readings for live analysis
• Poll updates - Monitor streaming analysis with synchronous or async polling utilities

​

Quick example

from atomscale import Client

client = Client()  # Uses AS_API_KEY environment variable

# Search for recent uploads
results = client.search(keywords="GaN", status="success")
print(results[["Data ID", "Status", "Sample Name"]])

# Get analysis for the first result
data_id = results["Data ID"].iloc[0]
analysed = client.get(data_id)

# Access time series data
timeseries = analysed[0].timeseries_data
print(timeseries.tail())

​

Installation

pip install atomscale

​

Next steps

​

API reference