atomscale 0.12.0

Python SDK for Atomscale.

Python SDK

---

The official Python SDK for the Atomscale platform. Upload RHEED videos, stream live data, search the catalogue, and retrieve analysis results programmatically.

Features

• 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

Installation

pip install atomscale

Note: The package was renamed from atomicds. Importing atomicds still works but emits a DeprecationWarning.

Quick Start

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())

Documentation

Full documentation is available at atomscale-ai.github.io/sdk.

• Quickstart Guide
• Upload Data
• Search the Catalogue
• Stream RHEED Video
• API Reference

License

This project is licensed under the Mozilla Public License 2.0.