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.21.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.21.0.tar.gz | 881.1 kB | Details |
Built distributions (wheels)
Total release size: 60.0 MB
Release files / atomscale-0.21.0.tar.gz
| Download URL | atomscale-0.21.0.tar.gz |
|---|---|
| Size | 881.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a73a6e4ef21c8a7eb0922e4d31b4a2e649594816e995708651cfb5939d884d29
|
|
BLAKE2b-256 checksum How to use checksums |
b7873e8b8c144d2a29a9d6f5f4544bfe1336fcbc94e718aa957aecdf8e2f3f4a
|
| 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.21.0-cp313-cp313-win_amd64.whl
| Download URL | atomscale-0.21.0-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
67240d66f8ce6e2ae2b17a7b78f351a2bfc0f04d5de36d45dbbe720c564d7cf7
|
|
BLAKE2b-256 checksum How to use checksums |
1661e9f5f32a2e34d51fe744472f0c1bd3ab33530b3d69564c0ff1c097bbf151
|
| 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.21.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.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 |
0e69f5f755dfa5a65d2be01ed96efe715defe41b65816116033f762f8a991bdb
|
|
BLAKE2b-256 checksum How to use checksums |
14ae550d4459dd365f84360f8aea7b61f6dbd7ce8556d4c57d7e4fdc62177b97
|
| 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.21.0-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.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 |
ecd3463f28792b6d233045e6a84a5bb482bda4893343acd028aa788c2f78fda7
|
|
BLAKE2b-256 checksum How to use checksums |
7a276000cf214846a954e72ae7bcfca975cd54576fc7e778e1fde216ac7f8163
|
| 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.21.0-cp312-cp312-win_amd64.whl
| Download URL | atomscale-0.21.0-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
045d59008318f33995a5d89df235b489290a9f7466dd59ce9bebcdd93df8663c
|
|
BLAKE2b-256 checksum How to use checksums |
d7a14d4684b71eec045a0e3ce38c273175254d38ac69fef06c1e0f724c20e3e7
|
| 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.21.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.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 |
f271bf23c6997e4efa5270f57801762e8a00cf941e3de32ff627e61fd4d00980
|
|
BLAKE2b-256 checksum How to use checksums |
72c4d4d936f9c32813ebea411423832916a53e57b4f75e2de5b215d83d88d363
|
| 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.21.0-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.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 |
0a809f3df247daee2bd40c3126a3ef64f39457b37baec8de1a9711394a51cb2e
|
|
BLAKE2b-256 checksum How to use checksums |
58028a8d6ed8a92f85178c6bfdbaf927573868c86430ee7472885221f4554e24
|
| 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.21.0-cp311-cp311-win_amd64.whl
| Download URL | atomscale-0.21.0-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
96768b615fee91520a1dd756fff16c23e4b77b994c35ff182d6a6fe096fda093
|
|
BLAKE2b-256 checksum How to use checksums |
96de9755de93246179a39bf507b67f6cbad81c5c5458959dea3345f522fb2464
|
| 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.21.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.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 |
0452e0f22aa8d80f5b89cee06f7532e8cc8cf61e161ce3dc40ed518ac4267c71
|
|
BLAKE2b-256 checksum How to use checksums |
05674d9838ae7c1193e684a58e684d46b96c65b22359084b8b51bc8bb2ff909c
|
| 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.21.0-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.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 |
e79130c9dd51fd7d1e06948d60e08bfdfad04114cbbff578557d91cad6440529
|
|
BLAKE2b-256 checksum How to use checksums |
3d849b9e0e77e29c4cb7f7e8365fa28744bef050494839b0ef564a2885ca5ed0
|
| 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.21.0-cp310-cp310-win_amd64.whl
| Download URL | atomscale-0.21.0-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
7a040e0894c14612039b217fddb6cd78cd68793aa9d204f0ab984d54febd36be
|
|
BLAKE2b-256 checksum How to use checksums |
161938923a0cba799333db87d222ccda8189f0756538a4ba808f52a069813d1c
|
| 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.21.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.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 |
10b2f4dfea947227d6b2ad64d5e78eb1c69938f96396ad3326c2671598c25a22
|
|
BLAKE2b-256 checksum How to use checksums |
d0e24d5552acd6d759cde3791896f7ea169a8e01f45ef681c0144ab4c66509a0
|
| 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.21.0-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.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 |
01f3aa7c339c4ef2fa768c66e8a3079856f1167f4727e13c26898a28439fe4b1
|
|
BLAKE2b-256 checksum How to use checksums |
d1dbaf67bbd947a7ad97177eb8e3fd35b31731060af2e310900bd61ed311b11a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
