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.3
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.3.tar.gz | 885.8 kB | Details |
Built distributions (wheels)
Total release size: 60.4 MB
Release files / atomscale-0.21.3.tar.gz
| Download URL | atomscale-0.21.3.tar.gz |
|---|---|
| Size | 885.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a88864269946e924d4f38ade0285a6da326b378fad6953f1a9edb8695a090e6b
|
|
BLAKE2b-256 checksum How to use checksums |
a2058c1a6bc0f358eb27ce8a9b00090492a1b956b60970bd8f98a735cd5ac15e
|
| 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.3-cp313-cp313-win_amd64.whl
| Download URL | atomscale-0.21.3-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
c76429c41aa2d078475cbbbafef852d53b56212683133fd2c36bf8163b9363f6
|
|
BLAKE2b-256 checksum How to use checksums |
53903e079784fef26312d43a88a7ef6c5b6e73f99b9e98b8e48b0a8f6bd17bc7
|
| 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.3-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.3-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 |
6202768e14e52f0c33608f25e50ccd54ccfb0f4eaf03231d7b9322e9575fd61d
|
|
BLAKE2b-256 checksum How to use checksums |
a021b89cb7f65f415de3ef52ecb52db9ec5ac2f5cb6012ff3c8d8792cfe53768
|
| 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.3-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.3-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 |
0072f0a384928996e822a737bdb217980260129576b6de8a6e32a2e951785539
|
|
BLAKE2b-256 checksum How to use checksums |
13f827d774045fb8b4b6d82fcc6be20f7b487b6fb4c8fe80cd50242b2ec30654
|
| 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.3-cp312-cp312-win_amd64.whl
| Download URL | atomscale-0.21.3-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
9ed5d3aeef406a83c6ad7baf78c01975f4c9417c5279234c9e3cc93da43dec5e
|
|
BLAKE2b-256 checksum How to use checksums |
d6d0d1ded706a3335072d701b981ca398e4466795b9415561509670dbc31b95d
|
| 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.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.3-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 |
b35b3f928b3aaaab5944bcfed4b2a25d9493f1d8ba19b7ba1b8062157649666e
|
|
BLAKE2b-256 checksum How to use checksums |
899b60a02523095ba55a779f9add080f946cf5849efa1b32689f6daf6704230e
|
| 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.3-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.3-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 |
9dd2681bfd4889538ff9b1eb462bf169de5894b36f01b5718ad52810413a2611
|
|
BLAKE2b-256 checksum How to use checksums |
351ae49f1d82c7887331d99499a657f51e1bc525cafeb69ee1716517b7866c8f
|
| 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.3-cp311-cp311-win_amd64.whl
| Download URL | atomscale-0.21.3-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
581709d18aeda9dbb5297f66009f0f26f0ec50f5b92095a5e2f9c8b644abb0c7
|
|
BLAKE2b-256 checksum How to use checksums |
c1199fadbe6c9f6281441f2a2cb1750d35cc70ac3732339d94bc01b1dc2a15e9
|
| 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.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.3-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 |
b435b0a9b2dbb408921d0072fc4adcfbbfcd53331e462ab2264e173cb114dfd9
|
|
BLAKE2b-256 checksum How to use checksums |
c7d559a617f4c9322c86cb038fd2475b8ec70647c2a66966352dd9f61cbe200a
|
| 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.3-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.3-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 |
077e3dbf434821f3d14f8fc3b7469954083c4c792c140ffe82385aae6bc131bf
|
|
BLAKE2b-256 checksum How to use checksums |
428edeb4346c46fb5c58848d5c90faa1b2af370f68b68d7a84d3083bb95fcb95
|
| 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.3-cp310-cp310-win_amd64.whl
| Download URL | atomscale-0.21.3-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
833cc0454317e7b2f1afea3a20abe63471c2d21e21815af0882dbbd759c689af
|
|
BLAKE2b-256 checksum How to use checksums |
155a2af514a72d7e64e2fe573b9c4724410473e83b376c0bcdb52a1573591239
|
| 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.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.3-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 |
bb4bbcf9a017fb84e515c0ff97159c4e64808e0a0a8dca2f2c04bf404039928a
|
|
BLAKE2b-256 checksum How to use checksums |
e578777408572ccf219622556b81a39937a3de0b51220185da11c51c77b8e786
|
| 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.3-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.3-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 |
947a5ceeed749a284ad1457021071d53e399fba03bdbe320069f8fe5ca7a8858
|
|
BLAKE2b-256 checksum How to use checksums |
d7a11678317080384beeb2dfb805b836458f8a21655369459717d19df32f7fc8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
