Atomscale Python SDK

atomscale is the Python SDK for the Atomscale platform. Use these docs to install the client, move data, and integrate streaming or polling workflows. The material is split into:

• Task-focused guides that mirror the published notebooks.

• Auto-generated API references pulled directly from the source.

If you need help from a human, open an issue on GitHub or email support@atomscale.ai.

Features

• Unified atomscale.client.Client for uploads, catalogue search, and downloads.

• Streaming helpers for live RHEED capture via push or generator-style interfaces.

• Fine-grained search filters for IDs, data types, lifecycle states, and time bounds.

• Rich result objects exposing timeseries, diffraction graphs, and processed videos.

• Polling utilities for synchronous, threaded, or async consumption of updates.

Installation

pip install atomscale

Much of the functionality of the package requires an API key. It can be provided using the AS_API_KEY environment variable before creating a Client, or passed in directly when constructing the client in your code.

Note

The package was renamed from atomicds. Importing atomicds still works for backward compatibility but emits a DeprecationWarning and internally depends on the atomscale package.

• User Guides
  • Quickstart
  • Upload Data
  • Search the Catalogue
  • Inspect Analysis Results
  • Stream RHEED Video
  • Poll Time Series Updates
  • Poll Similarity Trajectory
• Project Modules
  • atomscale.client
  • atomscale.core.client
  • atomscale.core.utils
  • atomscale.results.rheed_image
  • atomscale.results.rheed_video
  • atomscale.results.xps
  • atomscale.streaming.rheed_stream
  • atomscale.timeseries.provider
  • atomscale.timeseries.polling
  • atomscale.timeseries.registry
  • atomscale.similarity.polling
  • atomscale.similarity.provider

Indices and tables

• Index

• Module Index

• Search Page