Skip to main content

Atomscale

Python SDK

Testing GitHub tag Python License

Documentation


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. Importing atomicds still works but emits a DeprecationWarning.

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.

Metadata

Release files for atomscale 0.21.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for atomscale 0.21.11
File Size Uploaded Provenance Actions
atomscale-0.21.11.tar.gz 977.3 kB Without provenance Details for atomscale-0.21.11.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for atomscale 0.21.11
File Actions
atomscale-0.21.11-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details for atomscale-0.21.11-cp313-cp313-win_amd64.whl
atomscale-0.21.11-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.17+ x86-64 Details for atomscale-0.21.11-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
atomscale-0.21.11-cp313-cp313-macosx_11_0_arm64.whl CPython 3.13 CPython 3.13 macOS 11.0+ ARM64 Details for atomscale-0.21.11-cp313-cp313-macosx_11_0_arm64.whl
atomscale-0.21.11-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for atomscale-0.21.11-cp312-cp312-win_amd64.whl
atomscale-0.21.11-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.17+ x86-64 Details for atomscale-0.21.11-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
atomscale-0.21.11-cp312-cp312-macosx_11_0_arm64.whl CPython 3.12 CPython 3.12 macOS 11.0+ ARM64 Details for atomscale-0.21.11-cp312-cp312-macosx_11_0_arm64.whl
atomscale-0.21.11-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for atomscale-0.21.11-cp311-cp311-win_amd64.whl
atomscale-0.21.11-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.17+ x86-64 Details for atomscale-0.21.11-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
atomscale-0.21.11-cp311-cp311-macosx_11_0_arm64.whl CPython 3.11 CPython 3.11 macOS 11.0+ ARM64 Details for atomscale-0.21.11-cp311-cp311-macosx_11_0_arm64.whl

Total release size: 47.5 MB

Release files / atomscale-0.21.11.tar.gz

Download URL atomscale-0.21.11.tar.gz
Size 977.3 kB
Tags Source
SHA-256 checksum
How to use checksums
1be5eb2a2edeaf6a88635cf98596e016f250cbe9317651cb25a368ad04c09c53
BLAKE2b-256 checksum
How to use checksums
b737da8bb955ffa2a3360e00708290821d82cab161e634e13f0f45a066b12b68
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.11-cp313-cp313-win_amd64.whl

Download URL atomscale-0.21.11-cp313-cp313-win_amd64.whl
Size 4.7 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
4a80f4ff28c7f71655cf7250d3937df8e9134c831fa7838091738dae3e8c343b
BLAKE2b-256 checksum
How to use checksums
96c45645b3c4945593a343c706711c736f665001750897fad34b0d57156b805d
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.11-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL atomscale-0.21.11-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 5.8 MB
Tags CPython 3.13 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
b6e13c1a1ede6e034af720ef5441a628b9d4b53100cdba5823dad9e45bf9d7c7
BLAKE2b-256 checksum
How to use checksums
60578666ddb23bf36ad3b94ea0125430285426e44ed619c60e186787e1a6c23f
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.11-cp313-cp313-macosx_11_0_arm64.whl

Download URL atomscale-0.21.11-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
deeecb3a60ffe1ef19dde12850916089a2c969edef0a29e84125516bb6874f76
BLAKE2b-256 checksum
How to use checksums
e1fb970f8ab70b7ce6e21a575eeeced54c9035c184c6e5581f9f7d4c00f9433c
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.11-cp312-cp312-win_amd64.whl

Download URL atomscale-0.21.11-cp312-cp312-win_amd64.whl
Size 4.7 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
be843c1f25267892a82a5179fa2e02038fbae14608702c785683a2fcca665a69
BLAKE2b-256 checksum
How to use checksums
2a9a8605dbf7ffc337ae4267fdfd77a49dd325d1c0efa5a42843b11fec39e4b4
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.11-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL atomscale-0.21.11-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 5.8 MB
Tags CPython 3.12 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
3c3ea3fa165f0ae752c41ea376829a2ec2bc96d1f8d21cd639d5d6b1e0d4786b
BLAKE2b-256 checksum
How to use checksums
3725fe580a1cdd5c7d5e0cbd54ae654719ef17a06612dfe6b4ac704fa513be30
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.11-cp312-cp312-macosx_11_0_arm64.whl

Download URL atomscale-0.21.11-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
bd1bece1d74d4e84fdb5787c0d02d9f1ae70b0e6d6fee8eda94c8f7a5df58ebd
BLAKE2b-256 checksum
How to use checksums
2f158d3092e32b841c3cbec93044bd01e5f14d62e98881f5fec584f9944b63a7
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.11-cp311-cp311-win_amd64.whl

Download URL atomscale-0.21.11-cp311-cp311-win_amd64.whl
Size 4.7 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
36c0980725868959fd799387c82824a95c91fac11faa15f1dd828798e510d15d
BLAKE2b-256 checksum
How to use checksums
8422a8de21d006b9da758080907e8313a95d6c151f13c8a005c98b7cd5d2c01d
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.11-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL atomscale-0.21.11-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 5.8 MB
Tags CPython 3.11 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
829f082b2ae7fc3c5dac780d69939e3a195b7bb76908a0b704341056805bc382
BLAKE2b-256 checksum
How to use checksums
210a44305919e443445ef852948717c7ae25415e5d9060d05ff252940e04f6d2
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.11-cp311-cp311-macosx_11_0_arm64.whl

Download URL atomscale-0.21.11-cp311-cp311-macosx_11_0_arm64.whl
Size 5.1 MB
Tags CPython 3.11 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
20620c6272e1876b7ad03a680c83c668c06cb44a583f8dbac6a28ff154acca9f
BLAKE2b-256 checksum
How to use checksums
89653ba8c6fa5c72fffd2932da459a0c06ae96a08b167daec77323c595c24a75
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.11

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.

Release history Release notifications | RSS feed

This release

0.21.11 This release

10 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page