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.6
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.6.tar.gz | 989.7 kB | Details |
Built distributions (wheels)
Total release size: 60.6 MB
Release files / atomscale-0.21.6.tar.gz
| Download URL | atomscale-0.21.6.tar.gz |
|---|---|
| Size | 989.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
940f7f1817472d41fad44225ab417049ad77d3da4153b62626a4a1277c783c3e
|
|
BLAKE2b-256 checksum How to use checksums |
9fb2c592a73a3cb0dcd663fedafc98be9f7f6930252c978129e15d2ec7e3ebb8
|
| 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.6-cp313-cp313-win_amd64.whl
| Download URL | atomscale-0.21.6-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
092675faa411875ba12d572395537d467d0bd49d5d63642f1cafd7f2c098b149
|
|
BLAKE2b-256 checksum How to use checksums |
3949e3eb3cf31246d195cf6e9bab7a52b8573e60016f83fdda3c5d55906ecfb1
|
| 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.6-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.6-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 |
2a9337b1f036cdbcf2e6d86fdfc469ff2330c8f8b590d87f2a82783d8d105030
|
|
BLAKE2b-256 checksum How to use checksums |
9b3fcd01e1d7ea704d1dfe2892eba7c901f63213a88cac5fd72c44638113390d
|
| 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.6-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.6-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 |
91e2632d972695c0252c6ca2e847155ad7f77d73504e10453997c6b3224aa90b
|
|
BLAKE2b-256 checksum How to use checksums |
79479af3feffdcca0e847002f6c50d07f58cc601d2cc85c818c0c8d9f6557de5
|
| 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.6-cp312-cp312-win_amd64.whl
| Download URL | atomscale-0.21.6-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
8e15e2d781514e549820b36f4fb37eab8c1beca9b08c88b5ca661cbef92f9fae
|
|
BLAKE2b-256 checksum How to use checksums |
4134f12f85127e1380f759dc7f059661d2075aaab07316c3f18c6094cfa30f81
|
| 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.6-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.6-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 |
a6d5a4381e9084ad082bff4af3b8f59e05b412261a1677760c2bba50fe32906e
|
|
BLAKE2b-256 checksum How to use checksums |
bb69174ce79b97b97925a9594e51f696c22d74069ff1adf8760c78ac222e8ac8
|
| 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.6-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.6-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 |
a391d0926d119083f9dbdc55780dd8936ef0fbf1b580f94c2a2a977bc95fa098
|
|
BLAKE2b-256 checksum How to use checksums |
4ab656ce83fb49b350cd5113cea67e9bd75aa45238205960d2a5a0e515dd936e
|
| 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.6-cp311-cp311-win_amd64.whl
| Download URL | atomscale-0.21.6-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
3198ff9b7fc92b3ede6a1edb2d3e72c40ae75377393c5c4135a73f9a1277ae27
|
|
BLAKE2b-256 checksum How to use checksums |
0ed6727f02eb6813d81d640aa296980040be7134674d49043306a6539a29e991
|
| 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.6-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.6-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 |
4527aa113f77d35aa2799831774ad3d3d0056c2347e12ddf8e4d3991d457954f
|
|
BLAKE2b-256 checksum How to use checksums |
354980b4433635e1406e1f5e53aac027acad2b2526d04b311d9087d05402b490
|
| 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.6-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.6-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 |
9b13f7d3109c364027937ea064e3991b47a7421c71f614237557042546126848
|
|
BLAKE2b-256 checksum How to use checksums |
cfaf932833b44ace1259f5b50243ed96bb6b23a5353d1403c46716ed6bf2fffa
|
| 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.6-cp310-cp310-win_amd64.whl
| Download URL | atomscale-0.21.6-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
e7711a789868521b128625e4e6f7df1c960bf1dbfc203b31d566498d29c8b73b
|
|
BLAKE2b-256 checksum How to use checksums |
25fab2678e657689fc868488987a2748e6a9d0ee562870c9bd555f4676f7e830
|
| 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.6-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.6-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 |
d45f084a41f76d3c10eeca04fd46b49e64ad9cb7b93baa5606eaae11980a7fb4
|
|
BLAKE2b-256 checksum How to use checksums |
8a7cf292cc1a2f485c7c9334444bfa577c1b15ff3802d728bdafe20767e1ed8d
|
| 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.6-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.6-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 |
3c42dce2d2d0c3b6e904d640e3d9d764309c4a4787a645c2d6db12431f2818bf
|
|
BLAKE2b-256 checksum How to use checksums |
23d2d79d9fdf7689a804a7c818caef8a9c1a38b44002a5b39c3de27adad38f3f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
