The official Python SDK for the Atomscale platform. Upload RHEED videos, stream live data, search the catalogue, and retrieve analysis results programmatically.
- Unified Client – Single interface for uploads, search, and downloads
- Live Streaming – Push or pull RHEED frames in real-time
- Flexible Search – Filter by keywords, data type, status, or time bounds
- Rich Results – Access timeseries, diffraction graphs, and processed videos
- Polling Utilities – Sync, async, and threaded options for monitoring updates
pip install atomscaleNote: The package was renamed from
atomicds. Importingatomicdsstill works but emits aDeprecationWarning.
from atomscale import Client
# Create a client (reads AS_API_KEY from environment)
client = Client()
# Upload files
client.upload(files=["rheed_video.mp4"])
# Search the catalogue
results = client.search(keywords=["GaN"], status="success")
# Fetch analysis results
items = client.get(results["Data ID"].to_list())
for item in items:
print(item.timeseries_data.tail())Full documentation is available at atomscale-ai.github.io/sdk.
This project is licensed under the Mozilla Public License 2.0.
