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.2
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.2.tar.gz | 885.8 kB | Details |
Built distributions (wheels)
Total release size: 60.3 MB
Release files / atomscale-0.21.2.tar.gz
| Download URL | atomscale-0.21.2.tar.gz |
|---|---|
| Size | 885.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7063b1ae69c7add157180158bb4e56e99f8b8515de180d750d07b973b6d72181
|
|
BLAKE2b-256 checksum How to use checksums |
95c77af7a1a5413c530c52a626a2ed20f7c7adc499ab5fd120c9ca182f5bcdcc
|
| 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.2-cp313-cp313-win_amd64.whl
| Download URL | atomscale-0.21.2-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
e55765d90c8d5c2782a75643d18cf0844cfb66e3f7a3a242a5daca372afb30bb
|
|
BLAKE2b-256 checksum How to use checksums |
e37fbed6d13909d26976f78cf761fdb12dc5653a88414acf7ff6ff573087af7c
|
| 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.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.2-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 |
ed3c5ce6551a76c75e3bc54faa5da71b4af6884e3ef5f470c046699a2fbef24d
|
|
BLAKE2b-256 checksum How to use checksums |
78384b7a698b848d86bc611b8910420d714f81d133266cf910b6977110d46cee
|
| 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.2-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.2-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 |
42bb686e654fe325952d611e5cfd3b119580dc7a9bdce0cf03f558f61bb152d1
|
|
BLAKE2b-256 checksum How to use checksums |
e9603fe1803599cdef0d39f8fc1b3d635c918b2932be56af5fa8d2afccd84119
|
| 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.2-cp312-cp312-win_amd64.whl
| Download URL | atomscale-0.21.2-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
96151e85c4201fbfcfc0ca40ff319d78e7724151a9c551ac5ccc8bf4f59bc025
|
|
BLAKE2b-256 checksum How to use checksums |
d5f6f3cd3cfa85b0a9119456694b76c7e84e37a245cac392879c98e3d5de2e75
|
| 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.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.2-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 |
191ed981cf703bc8e732aa6acb7cb52b3ce58a601533b88f0c36ea03b76d72b0
|
|
BLAKE2b-256 checksum How to use checksums |
7740c43f76e0200f0ef72c96d8d4ca53e22a24ada0fe8298cc119a7e029ba216
|
| 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.2-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.2-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 |
0444b8f7467fdfb76cd4d13fe2faea2a0d0283fa73bdb6246fcb5a10d854b46f
|
|
BLAKE2b-256 checksum How to use checksums |
5d40e830b71fb782b3afd87804b03a4a676f1a217354294193dfb6b05fac12bf
|
| 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.2-cp311-cp311-win_amd64.whl
| Download URL | atomscale-0.21.2-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
1b96c3600e42566ceccc5d1c6b03bd34b1e6e2cc22a87b3b5b03439c29ccbf04
|
|
BLAKE2b-256 checksum How to use checksums |
417a0e27a2fd1a809ab49c6b01fb6903c6fdeaa6d68616fedffd74329f060915
|
| 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.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.2-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 |
1f64d9806f0a0313e346f2a6f4ccecfec0e8f09eea307aba831c0b71ee636d5a
|
|
BLAKE2b-256 checksum How to use checksums |
9a349fbad15db3803293e0e9d7e284c78ad3f6fac7c5550fe9a06b0f1946326b
|
| 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.2-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.2-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 |
cce8f37baab413da5fc11a973808038a3b56bec9bf288d8d4e956b2c1c034bb3
|
|
BLAKE2b-256 checksum How to use checksums |
d0d2758417f908519463959e8e8cf2450929a50347c634a8ead4bc96dec14c4e
|
| 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.2-cp310-cp310-win_amd64.whl
| Download URL | atomscale-0.21.2-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
19200fe5898ef1d2ee50ebd0233c0655ff3c075d4c6f7febc7d0dc66d0ed9eec
|
|
BLAKE2b-256 checksum How to use checksums |
75df20b4fc90eb3956284b67d8ba35e0759740d85f6d94cd8cfeaa9f9cab22d2
|
| 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.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.2-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 |
6b036be5c9a38a79e8dc610be78dcdd3b3eb2a2632b08a7d5cc7579f4609f9dd
|
|
BLAKE2b-256 checksum How to use checksums |
55b09cc8c6bb04b2c737913ccb4b8428dbe9df7902275492a33c5671b36fef7e
|
| 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.2-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.2-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 |
8c8ae3f38c670eedb21e597d533f08ec576f420bedb01e2534075b54b1e750db
|
|
BLAKE2b-256 checksum How to use checksums |
5f8c203800bd4471fcbd059d4932e0be3ec11b98b85383041d53f5938b514b73
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
