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.5
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.5.tar.gz | 899.7 kB | Details |
Built distributions (wheels)
Total release size: 60.5 MB
Release files / atomscale-0.21.5.tar.gz
| Download URL | atomscale-0.21.5.tar.gz |
|---|---|
| Size | 899.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
54b588971e40a85a482202abe8d4701df7408ef9e089b768f3b825713916506d
|
|
BLAKE2b-256 checksum How to use checksums |
c7ef5491c5d0762efe4c84abe4d4a12451c0c8e5318b7b2ccbf451c0d0ed378c
|
| 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.5-cp313-cp313-win_amd64.whl
| Download URL | atomscale-0.21.5-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
1275532cea567956e890034053eafa91ce113e9bb7ca0ece89a4f044143b691b
|
|
BLAKE2b-256 checksum How to use checksums |
1bfc7fd4a6c82c522206db06850c259d9bc5bab479804940c4d92915b20ef310
|
| 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.5-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.5-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.6 MB |
| Tags | CPython 3.13 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
004d8cccecc329cc9da5ab4aa4b40b0c51ca38b39a0bbc6d12895a99cc0f6792
|
|
BLAKE2b-256 checksum How to use checksums |
5a2ea64122dc4368d855380a614fe16265e4f62c930cc8885657857acbe2c332
|
| 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.5-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.5-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 4.9 MB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
0f6246023f93cb2458dbd4a08584bcb26a6e11c85a7268035e5619c54592a2db
|
|
BLAKE2b-256 checksum How to use checksums |
919efee947bca499cff8609b21723c6b839cb62a4f5e4d2281b14ed823ae9927
|
| 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.5-cp312-cp312-win_amd64.whl
| Download URL | atomscale-0.21.5-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
b79473a459363015358781eb3ae09e1147a318032c00e2f8fe126d9b1e362ae0
|
|
BLAKE2b-256 checksum How to use checksums |
c22a84361b74a1c8fa8f3680d4b696867d7561f2fc7d3bd9afc4f8ccf898c674
|
| 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.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.6 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
b072f8de6c8a7ceab1dd24945aca07197f30388fb4eb7711c78b3a3042fd3597
|
|
BLAKE2b-256 checksum How to use checksums |
80e4b530a32d2d02610b39a988fc0b44fe8ed24678ccdc268746ff5686508515
|
| 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.5-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.5-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 4.9 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
eb7b7890dcfc8c49633810e3610732e38cad68c44317acf5121476610ddacd3b
|
|
BLAKE2b-256 checksum How to use checksums |
fa8cec55885ab4a0337f1c5fa9cccb546431e1bf9bb222678e0edcbcd130e06e
|
| 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.5-cp311-cp311-win_amd64.whl
| Download URL | atomscale-0.21.5-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
9eb0249a901d8b185b83dc9d3359537ba22dc648f1ee3a17758b94e70ed10fde
|
|
BLAKE2b-256 checksum How to use checksums |
97d986043b0e4ae9f0803d6e2e35359f7415cf07f50385b21542424a332af63d
|
| 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.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.6 MB |
| Tags | CPython 3.11 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
46cbc86d194636e0b4bcc57abff3eabd204c18266f134ebb56ddfbf7f9b7afe3
|
|
BLAKE2b-256 checksum How to use checksums |
0c163ea0610b6fc8ea7f108e4110290229530649127f307c55df53de54dbbd8d
|
| 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.5-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.5-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 4.9 MB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
abae190784d49eebb34cd51e593af8ae377382d61e32d616f6118cf5d01548ae
|
|
BLAKE2b-256 checksum How to use checksums |
5f289cf815a00df160587f8296328ef9f65ada2db633cbce354d2949b7ba2d74
|
| 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.5-cp310-cp310-win_amd64.whl
| Download URL | atomscale-0.21.5-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
31f25aa3a1bcff82722e26823483babce90963522bd84fcad468d89aa3fa5b8a
|
|
BLAKE2b-256 checksum How to use checksums |
38485fe19472eca25d2e4da5cbc1ef194d1124ded8eae2a44d4a4f0b1aae49a0
|
| 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.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.6 MB |
| Tags | CPython 3.10 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
60c945ec4f07a3a3c113c14c30accf3d2cd2ba316b9bfb2a9b0146cffeaf95fd
|
|
BLAKE2b-256 checksum How to use checksums |
893dfad2eeae2f02c7805fd2dbdf9a8386c8ed23e3fff159c48bcd57a7ee878c
|
| 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.5-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.5-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 4.9 MB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
ee8a8a83157e0456809cc53e348d47d66835d9d0e39f7b92b95fe7ca8e553d35
|
|
BLAKE2b-256 checksum How to use checksums |
6ac65bc174b90f1377314ed5109bc1d597c6b2789e54697dad8795634669a30e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
