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.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| atomscale-0.21.10.tar.gz | 969.9 kB | Without provenance | Details |
Built distributions (wheels)
Total release size: 47.3 MB
Release files / atomscale-0.21.10.tar.gz
| Download URL | atomscale-0.21.10.tar.gz |
|---|---|
| Size | 969.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e871af6b75d36c4011fcedad8d576932117581dd4430d0e866b6bc98384faef3
|
|
BLAKE2b-256 checksum How to use checksums |
b93ec9e9d1943e2955e249a42a4473d5e7f106abde398831acb9c4a580ae5d24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / atomscale-0.21.10-cp313-cp313-win_amd64.whl
| Download URL | atomscale-0.21.10-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.7 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
b17ad17be214a57b1e4e99c288e2348cd94cbc85cd7fe422b6a486f455b17e3a
|
|
BLAKE2b-256 checksum How to use checksums |
9e2926eed070eb75aab6a3354a5e6d73dd0b0e752bccb2d6cf952703dc2bfcd3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / atomscale-0.21.10-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.10-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.7 MB |
| Tags | CPython 3.13 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
44dea91ea11b289ac98d9de480b1eba5b1443802dbcdc1574ed2050badd747a4
|
|
BLAKE2b-256 checksum How to use checksums |
733c6b8d0471123e3ec4ab70b611c4fd5e7bd6d1b6233912417117b4ef0e7684
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / atomscale-0.21.10-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.10-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.0 MB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
a21bb3471bded32a05bc1bfe1c091eb85ab5a447ff388898db00407a891fc01a
|
|
BLAKE2b-256 checksum How to use checksums |
e6f777eacbacdcf365e9370d77c4d8c479e2e78e7b3e00a62190acf107975562
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / atomscale-0.21.10-cp312-cp312-win_amd64.whl
| Download URL | atomscale-0.21.10-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.7 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
2ad5b821e24d747b3d1987d0d6796405a36409ebbf6854df64bdc3a1eab3797c
|
|
BLAKE2b-256 checksum How to use checksums |
0339ed8404e80de468a5dd02cc3f93e7addff68ca28360a29098c93261f79812
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / atomscale-0.21.10-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.10-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.7 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
905e20f1a169a90115fb73ca024b58030489fb26229827fae5f9a09522387416
|
|
BLAKE2b-256 checksum How to use checksums |
9f58f3ee2bbb2386e9fe5a9a85f627ddfa15c0c6779cf3f57ad311410e4cfedf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / atomscale-0.21.10-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.10-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.0 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
a70d87e6047a47df084402188cf4ea44675ab09a2995a09519de9dba9b7301a1
|
|
BLAKE2b-256 checksum How to use checksums |
651a2ccc5e26987e4ac66bd57f168cb05af8eafbe1ad604c256bbe1ed8b0830a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / atomscale-0.21.10-cp311-cp311-win_amd64.whl
| Download URL | atomscale-0.21.10-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 4.7 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
9bf0efa574a5a806ee232e2666b6d36604dbb5723915db21f534c85fbe981750
|
|
BLAKE2b-256 checksum How to use checksums |
af0fb591cf8a050d821621a745bc7e6686135deeded986d69862aae3f048462e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / atomscale-0.21.10-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | atomscale-0.21.10-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 5.7 MB |
| Tags | CPython 3.11 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
c3953947010e21b9273bb7695eb1bb85984478bffc47e1648be6437456e03712
|
|
BLAKE2b-256 checksum How to use checksums |
7b05390d6fbcd7abfe83c08f37a16f3d508ea5c49213c889c84d5e4b28398210
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / atomscale-0.21.10-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | atomscale-0.21.10-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.0 MB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
37dc0ece34adcff7525394f786065177704efe09ad63e46a7220b90896601753
|
|
BLAKE2b-256 checksum How to use checksums |
d97b2c78a61b873d2ed075f6b0ad9ad41741d737c695961acd2b88f5f0011a4d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for atomscale 0.21.10
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
