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.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.21.1.tar.gz | 883.0 kB | Details |
Built distributions (wheels)
Total release size: 60.2 MB
Release files / atomscale-0.21.1.tar.gz
| Download URL | atomscale-0.21.1.tar.gz |
|---|---|
| Size | 883.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1e01ee96bb925fc1debf1779607e6554f5067e363782c4bf485a56be9461ae24
|
|
BLAKE2b-256 checksum How to use checksums |
0df7f02d3bf05ef6cee45d3fd5bc4929d22db4ef8843b28b44e30a709e4b0672
|
| 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.1-cp313-cp313-win_amd64.whl
| Download URL | atomscale-0.21.1-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
3bee3423b9b5845bfd854b4178d2f896d889e7c0a2d02ce896d13cb905779644
|
|
BLAKE2b-256 checksum How to use checksums |
578df653f54f38b7be0056fb24dc5696bb5cef114e3369e11ebfa6dc9f8fc2b8
|
| 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.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.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 |
b40022a94d604891c5d14600f28d77b79fc04a1c97c3c3f87318a8787547641c
|
|
BLAKE2b-256 checksum How to use checksums |
af2bac01db6e2bd09196fad3e9b7b7fa293090fd4f5bef94cf3466d4a96b48ec
|
| 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.1-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.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 |
90a8b26afdf42604567576cf72d01d302c6782b19e5dab72edb33d53bb6c42f1
|
|
BLAKE2b-256 checksum How to use checksums |
52c9a9d7c392987d88afabe3a2cc9689ab1f10cde3142859e1a20ad8ea511161
|
| 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.1-cp312-cp312-win_amd64.whl
| Download URL | atomscale-0.21.1-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
82de8e3514aa15cdda626e06f97f3b99b4c65384207a87b724a3eed1578dee8d
|
|
BLAKE2b-256 checksum How to use checksums |
b4a909d72e4647e315c457b6fbfa92fc1528808025b8d7fe89e5d41340416d2e
|
| 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.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.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 |
61cc3da6da0f316edf3b0e92c87d75d78b012653a40841dc9eb11189f01e0119
|
|
BLAKE2b-256 checksum How to use checksums |
b3ca76f9fd5ad48a2b97b2505d77b6697b799c4808904ae5bc78c1f92315f2d7
|
| 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.1-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.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 |
418875d9593374582cb5d2292b3bc25724f6def3145c1b8b4d67f22e1c9f80b4
|
|
BLAKE2b-256 checksum How to use checksums |
95ad9f65e020be4865eb59887eee74ba9e6ee3b713240f8901fa11414a6b8136
|
| 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.1-cp311-cp311-win_amd64.whl
| Download URL | atomscale-0.21.1-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
9afdcebeb9dde0f61706951063dadafb0735e29a28db23353255652cea0bc56f
|
|
BLAKE2b-256 checksum How to use checksums |
3742c8a3da2bd3e865546b8dfed0be283853d87d02d0a9678b10a574a1584b93
|
| 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.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.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 |
2fb408c909bfa26612f7cb6a21017ab6bea63dba9ec32cf014f1793af832fa8d
|
|
BLAKE2b-256 checksum How to use checksums |
18078f78e9a45e09c29f07ec6656467395e65c1c577721f32350dcf7f5762e8a
|
| 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.1-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.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 |
13bbe6c95b450241f151834866d2b9f467e0ffe40d93e2db91d307f6736a2ae4
|
|
BLAKE2b-256 checksum How to use checksums |
c68fad255b93919c5594141a78c1f513e48872900b0d1de665fea9d36a83791e
|
| 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.1-cp310-cp310-win_amd64.whl
| Download URL | atomscale-0.21.1-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
0bb2c6416a4c960b6d1db8924384e5234e2f333d53ec45b2286f0590a846dc38
|
|
BLAKE2b-256 checksum How to use checksums |
769837d232cddb2edea8fcfacb76d5489aa0a1c8fb5192e7349be9d8d76ed37e
|
| 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.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.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 |
f11be3d7469e168089e68f1e11826136a29d25ef21ef54db1bbcc75322522ad5
|
|
BLAKE2b-256 checksum How to use checksums |
b706260c6207a25ca52e2ed1e3144079b48ece58a3009021301b913eb734b403
|
| 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.1-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.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 |
25982a8cbb34eed80d426dedf4108df728a2956376f9162d0a686de52e78282b
|
|
BLAKE2b-256 checksum How to use checksums |
73174474feb458675cc4c95208de731bf75fbb637f23631667f0470ff8d7ca2e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
