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. Importingatomicdsstill works but emits aDeprecationWarning.
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.
License
This project is licensed under the Mozilla Public License 2.0.
Release files for atomscale 0.20.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| atomscale-0.20.0.tar.gz | 875.7 kB | Details |
Built distributions (wheels)
Total release size: 60.0 MB
Release files / atomscale-0.20.0.tar.gz
| Download URL | atomscale-0.20.0.tar.gz |
|---|---|
| Size | 875.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f5862d2c6a5e1bbc0d24073609814bc7bd882c8f12f3ea01b9e07db87c185c4a
|
|
BLAKE2b-256 checksum How to use checksums |
1252da20f23e4ecec0e4f479a272147c3f7d22ba4a97188d2a380c1855618a27
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp313-cp313-win_amd64.whl
| Download URL | atomscale-0.20.0-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
d8b87ec767c8434ce3b8e35d604e80a4cd0d410ddc903685b3c0cb20669bdf01
|
|
BLAKE2b-256 checksum How to use checksums |
3244e32aab35f2f4d5a4d5903203ebedf32537aace281e9a28a051f39f97cd77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.20.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.13 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
db398f0aa9414841ccc10c584314810f061a3b918cc8f1ca8ed5269762161e4a
|
|
BLAKE2b-256 checksum How to use checksums |
3e8f9d03f5dceb6922ee03703c7300b61c3f81065ec7599b0567e2013e3ac965
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | atomscale-0.20.0-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 4.8 MB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
dd10cc20d4f3c6e194bce0510f41ab1073b093bdec6b5f86f5433f01d5c749e7
|
|
BLAKE2b-256 checksum How to use checksums |
580cb941dbb7b323d2b7e82730da5ae2389b5357901b35e9a67ac45d31b2b188
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp312-cp312-win_amd64.whl
| Download URL | atomscale-0.20.0-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
9de702616a1ac569bb7ddb32994c98058aa50faccebb48d687b63775bd364e5b
|
|
BLAKE2b-256 checksum How to use checksums |
668bac936b9b7ea52540fe0af46e4188834722bd7dab45f1c3122606f5670b3c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.20.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
1f473aa096357805a8d079914be5e5663d328c51488e364f023ef558fa0aabbc
|
|
BLAKE2b-256 checksum How to use checksums |
a513503a76808a875c221d9ded81bbac2e7846e4079fdf247abde7c79f753e12
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | atomscale-0.20.0-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 4.8 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
5cec188882a5503032105d154bb9520d2692e32e6875dbb8b121671beca1b996
|
|
BLAKE2b-256 checksum How to use checksums |
f3b695edb8eebbc30b84d6cbc09e21a9ff986d61416d0b299a63707294f8e889
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp311-cp311-win_amd64.whl
| Download URL | atomscale-0.20.0-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
1745ca751f2a2a55cc9aa5af3f1463932f1e50d72554ba0d95fa70e0bb80eb30
|
|
BLAKE2b-256 checksum How to use checksums |
774346dda1a8181a680c6dbee0101d934dd179c9073a3769fe334bed44f8f99a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.20.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.11 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
06f40664b1ba181552c4d471250d8a6c40656020e7f692ae871c5e1afdca69b2
|
|
BLAKE2b-256 checksum How to use checksums |
01d3d94915744d772d7cf1a7927485530954d8167546ebfa962764049dd567e0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | atomscale-0.20.0-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 4.8 MB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
ed6977a0cbc96c267110f232127060adad4779591c64776da4114eab609e24b2
|
|
BLAKE2b-256 checksum How to use checksums |
41558453a9263b45e58160c4f047b031e0d205acc303da7bafdc6ff42c02e369
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp310-cp310-win_amd64.whl
| Download URL | atomscale-0.20.0-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
4d24aabf7ee3bf2c7c0065f5be4c4c5a816ef42fb2c1020c945628a05dfc794b
|
|
BLAKE2b-256 checksum How to use checksums |
fb413eac31824c3ee64cd083cb4543f82393720e4b7f8dcd6af1ec296ce73d3a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.20.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.10 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
27f013091605615bf6450d99848e301bc2b7ef486917cac49ec8be182cf08253
|
|
BLAKE2b-256 checksum How to use checksums |
e77e19e91134943ce86717030db943750be7799cde8719e28ec61e1c1a5d7596
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / atomscale-0.20.0-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | atomscale-0.20.0-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 4.8 MB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
d8668b2a9ae7b3cc0f44ab82b3648668f8539545905c7262653398baecc5965e
|
|
BLAKE2b-256 checksum How to use checksums |
e2a2994281082ecf2e6b426100356b29386724bfb96a09688a80019bc3281928
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
