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.1
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.1.tar.gz | 875.6 kB | Details |
Built distributions (wheels)
Total release size: 60.0 MB
Release files / atomscale-0.20.1.tar.gz
| Download URL | atomscale-0.20.1.tar.gz |
|---|---|
| Size | 875.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
50a059a92f5c1d574386cc1d18f156b79a4d02e9aa3cac2ae5462da612768094
|
|
BLAKE2b-256 checksum How to use checksums |
9d1870f3ee6664bb880328f4ffc7c6776dc5e98df50e7aa6296eee1ea38900e0
|
| 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.1-cp313-cp313-win_amd64.whl
| Download URL | atomscale-0.20.1-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
f68d4c1aa37b9570f97e1abc9efbfeaf6eee808a9274602cd1c089122cc9355a
|
|
BLAKE2b-256 checksum How to use checksums |
c2b044637236a8495276eab20409d307f139061cc9749d0a54c12727c02e1823
|
| 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.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.20.1-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 |
f7d178452f2af9d98aec40e92e048866ed8662549383144a53f31cdd7f9b5dda
|
|
BLAKE2b-256 checksum How to use checksums |
becc3ee9329f54708a9438a46c130e8b0d7841bfb59bb0f460911b68e5d8ca3e
|
| 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.1-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | atomscale-0.20.1-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 |
3e3bd165f8ef3775c412c29594e1c0732f4bc89d0774288a5418f8f72994503e
|
|
BLAKE2b-256 checksum How to use checksums |
6e02be83eb388129bad4e0fac9eb373b5e39205d965357f979f2b68b62ac2bad
|
| 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.1-cp312-cp312-win_amd64.whl
| Download URL | atomscale-0.20.1-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
50bfee549a7b56c358b9e6cc2728eda5211da4e7b1e7d69d543a88ec60f03d5b
|
|
BLAKE2b-256 checksum How to use checksums |
1e50f7577cb79b730c8fb9b574792c7136d3e9c8f47d53ff4ba64a70652730f0
|
| 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.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.20.1-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 |
dcaed048772cc2826cd9cfdf93c0d9b5c68bb6feba793f7eadd8c8783adf742b
|
|
BLAKE2b-256 checksum How to use checksums |
455a57519ad092e7b6f8297a291f2e18d097bcf99b8c7c47e66949bf5794433c
|
| 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.1-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | atomscale-0.20.1-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 |
1453e7bbaa90a5c4342d02a09eeedc8c321dc8ef69734b41444ac7855d7e2f7c
|
|
BLAKE2b-256 checksum How to use checksums |
8bb8146dc31d7bfae3ff404da5a1ef3c5e7c8948bec700885126d85f4a07fb15
|
| 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.1-cp311-cp311-win_amd64.whl
| Download URL | atomscale-0.20.1-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
d42d3872377912cf5eb4eac50e41ac0fe6641e7875508d53256d3e618fc46b38
|
|
BLAKE2b-256 checksum How to use checksums |
369396cc0c12b4037445854ad7383f10f37bcdbd3db91be298a765b23f4da100
|
| 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.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.20.1-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 |
db55220d289c40f3046a42a492c4ca0b13d977691e11e511c5d1a358cf3f0fba
|
|
BLAKE2b-256 checksum How to use checksums |
4fedc792f168cbee6829d07f5777dc8a6d776c1b17216cdced142cb436cca6b2
|
| 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.1-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | atomscale-0.20.1-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 |
3f6cb6f7a8bc1d867e4b84133862a980c14f46f9f7ac812b19df9b6339a81d8d
|
|
BLAKE2b-256 checksum How to use checksums |
7b672e3c50f3fb6bfbf3227cb0011681c0fc2f3d0d11d36d44b587e25cf41b85
|
| 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.1-cp310-cp310-win_amd64.whl
| Download URL | atomscale-0.20.1-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
eb08d5ab9241b25f5cdd3cdcf4499acc0ec5150fd2165b8842d11d39d698365f
|
|
BLAKE2b-256 checksum How to use checksums |
00d881289ba0d5f51ef30a08cea63e59be83e6b55bfb7ce15e4d4f6b515c20e5
|
| 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.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.20.1-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 |
13143040e75b04f0c0b17792376194e70a75ae6eb4880b029b6556766a51d0b0
|
|
BLAKE2b-256 checksum How to use checksums |
aa7836d947d9c7549d9ca1264a526b769300738049c77b68f0b356a4749c2c97
|
| 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.1-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | atomscale-0.20.1-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 |
0cfaaa21fcd7bd8a2300d35891230b1a747791840fed1130b983dba34bd7cd84
|
|
BLAKE2b-256 checksum How to use checksums |
d48c8c012b09ee01cf88173c3e3c5d4793c20e06ec143091c5739b2d37caa964
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
