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.4
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.4.tar.gz | 899.7 kB | Details |
Built distributions (wheels)
Total release size: 60.4 MB
Release files / atomscale-0.21.4.tar.gz
| Download URL | atomscale-0.21.4.tar.gz |
|---|---|
| Size | 899.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1512d7f842fdd5bad3e19c57b7851866632bab8397a08fefcbe068ad18de0c22
|
|
BLAKE2b-256 checksum How to use checksums |
02a3c40e6b818041a9073dec9a4ee755b09b4ef8aee0fb9e95e594de22075818
|
| 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.4-cp313-cp313-win_amd64.whl
| Download URL | atomscale-0.21.4-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
dbbe3264c23250c150a844cff9137744d53636f6bc468d442bfee71e236de32d
|
|
BLAKE2b-256 checksum How to use checksums |
355dd8623e70a2570c752bc7522d820c5bd87e0cb2a8c31c6fecb33ee7c46993
|
| 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.4-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.4-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 |
ad89562f3e1afb49dbc57f7c2f95b1825b91333b15e3578a36c0194a66be551e
|
|
BLAKE2b-256 checksum How to use checksums |
7aa7f63caff43ded0281632abe7469bf14b057bb64a915561e6661d121813261
|
| 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.4-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.4-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 |
121219a9dc340baf4d7d9862abf900552617af6b3651b1c687bdbdcc2679831b
|
|
BLAKE2b-256 checksum How to use checksums |
49740192a4f0e36e166215c9c945e421517b54bdb7793e514b49d705fe9eb319
|
| 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.4-cp312-cp312-win_amd64.whl
| Download URL | atomscale-0.21.4-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
d574b6acd45b24fb7e566b0e6a47dc54c9e0aedc61b5a5ed4aaf55138d472481
|
|
BLAKE2b-256 checksum How to use checksums |
6f37c89fac3505b27357e46facb4c2fc674f5ab067af59dc4d76f5353b864a3e
|
| 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.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.4-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 |
f3033ce211c6dcb8fcd786f1144cafcc16dd7dbd91a963f1d10cff6896026804
|
|
BLAKE2b-256 checksum How to use checksums |
58ffceae2d0a41cf757d470f764cd8b48236410543ccfeb95c73c3793fb8b98a
|
| 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.4-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.4-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 |
1e33d964a1f1d9eeb1da68f322d0551cbd48ba827491affa3683442128dc6775
|
|
BLAKE2b-256 checksum How to use checksums |
d651c6149b740eb38bada0331484cbf51fdea44e8f7e827ab12c59a481a33f3f
|
| 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.4-cp311-cp311-win_amd64.whl
| Download URL | atomscale-0.21.4-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
d98a6ddff9e460a5c0202c3990caade355fdcb94dd53d206bd5413191bbce09a
|
|
BLAKE2b-256 checksum How to use checksums |
ea9251edcf8f20845526606ae72748803a51a3c925d8e80b9dd7238738d94280
|
| 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.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.4-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 |
4be51db2b77908dfc2111d1be2d2de9765e4b74e670c5a6e6bc7038bd2eb02ba
|
|
BLAKE2b-256 checksum How to use checksums |
c2553c9a85023006241e130fff1b3ac5cbc4c2bd03ec962e5aef225e9a9c078b
|
| 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.4-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.4-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 |
20e15c32431348e369b66a0cf01c6012e9ed3c3ae77c9e68dde3d7e56657cafe
|
|
BLAKE2b-256 checksum How to use checksums |
a20b584e9ec962a167ebd881e6e4758ffff85b7a0318d80e012baee59f917760
|
| 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.4-cp310-cp310-win_amd64.whl
| Download URL | atomscale-0.21.4-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
72ee173f97e20bb4572c31a8f1386d4597dea0ff04547193d00a8dc0d42bc04b
|
|
BLAKE2b-256 checksum How to use checksums |
bddd0c7cb5768ea91e0b3025093d3bbec54fcbb6ee18fc325156e6374eda39e2
|
| 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.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.4-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 |
7abfb6c5b1b803fb7af3aac2c3546fc79a0f0ad7ea9a7f5c2bfec07041ca2ee4
|
|
BLAKE2b-256 checksum How to use checksums |
f0b0a16e3ea74d242f6c4931a419442aa3cf7006c59a9ce1cbb2520c57b06694
|
| 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.4-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.4-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 |
02115748eff8cf3a81cedf371c3300ec70d488ebc01da115912ee7d7074cf91c
|
|
BLAKE2b-256 checksum How to use checksums |
3b531f78cfedfbfa7d7e63155a6b962d5c66595acb036b85a6ecf033503f8f24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
