Atomscale Python SDK

The atomscale package connects your Python code to the Atomscale platform for RHEED analysis, XPS processing, and instrument data management.

Installation

pip install atomscale

Set your API key (from Profile > Account Management in the web app):

export AS_API_KEY="your-api-key"

Quick Example

from atomscale import Client

client = Client()

# Upload a RHEED video for analysis
client.upload(files=["growth_001.mp4"])

# Find your data
results = client.search(keywords=["GaN"])

# Get analysis results
analysed = client.get(results["Data ID"].to_list())
print(analysed[0].timeseries_data)

What Can You Do?

Send data	Upload files or stream live RHEED/instrument data to Atomscale
Get results	Search the catalogue, download processed videos, access analysis data
Monitor live	Poll for real-time updates during active streaming sessions

Guides

Getting Started

• Quickstart

Send Data to Atomscale

• Upload Files
• Stream RHEED Video
• Stream Instrument Data

Retrieve Results

• Search and Download
• Analysis Results
• Monitor Live Results

API Reference

• Project Modules
  • atomscale.client
  • atomscale.core.client
  • atomscale.core.utils
  • atomscale.results.rheed_image
  • atomscale.results.rheed_video
  • atomscale.results.xps
  • atomscale.streaming
  • atomscale.timeseries.provider
  • atomscale.timeseries.polling
  • atomscale.timeseries.registry
  • atomscale.similarity.polling
  • atomscale.similarity.provider

Support

• Issues: GitHub

• Email: support@atomscale.ai