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.12

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.12
File Size Uploaded Provenance Actions
atomscale-0.21.12.tar.gz 976.6 kB Without provenance Details for atomscale-0.21.12.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for atomscale 0.21.12
File Actions
atomscale-0.21.12-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details for atomscale-0.21.12-cp313-cp313-win_amd64.whl
atomscale-0.21.12-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.12-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
atomscale-0.21.12-cp313-cp313-macosx_11_0_arm64.whl CPython 3.13 CPython 3.13 macOS 11.0+ ARM64 Details for atomscale-0.21.12-cp313-cp313-macosx_11_0_arm64.whl
atomscale-0.21.12-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for atomscale-0.21.12-cp312-cp312-win_amd64.whl
atomscale-0.21.12-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.12-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
atomscale-0.21.12-cp312-cp312-macosx_11_0_arm64.whl CPython 3.12 CPython 3.12 macOS 11.0+ ARM64 Details for atomscale-0.21.12-cp312-cp312-macosx_11_0_arm64.whl
atomscale-0.21.12-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for atomscale-0.21.12-cp311-cp311-win_amd64.whl
atomscale-0.21.12-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.12-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
atomscale-0.21.12-cp311-cp311-macosx_11_0_arm64.whl CPython 3.11 CPython 3.11 macOS 11.0+ ARM64 Details for atomscale-0.21.12-cp311-cp311-macosx_11_0_arm64.whl

Total release size: 47.5 MB

Release files / atomscale-0.21.12.tar.gz

Download URL atomscale-0.21.12.tar.gz
Size 976.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0f12253ec584b228497e03bd65fe0c2eeec7d729a45130adf6d76b8d1216e14d
BLAKE2b-256 checksum
How to use checksums
a20dd8db84da5ecd3c96e93b2196e71702fff2eb94c18c8e14676c686709fe21
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.12-cp313-cp313-win_amd64.whl

Download URL atomscale-0.21.12-cp313-cp313-win_amd64.whl
Size 4.7 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
539740031ca4dc300ac916c7e9f9919fac853e83da3ce2bf850e62d0cd1713d3
BLAKE2b-256 checksum
How to use checksums
99a6ce5d5b5d80816cebc0210822587ae03fe0349896c49b63ca271b89a2c2c3
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.12-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL atomscale-0.21.12-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
0dc735cd6619634a48feb09b2b472cc64997347bebde1f8b891d43d2d8054122
BLAKE2b-256 checksum
How to use checksums
388521a145c013ce909585ec40d6a639c5db2b367ad1e3a82cfbb7dcc6cb9088
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.12-cp313-cp313-macosx_11_0_arm64.whl

Download URL atomscale-0.21.12-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
9e903e895e63049226b2ee448194a90489e1efd4f2316a5307e28ab7e5d0145c
BLAKE2b-256 checksum
How to use checksums
b7f7a93566e5c25fe7c42c0cd3072071703d24925ec43da5c9d5a8636f2e45e1
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.12-cp312-cp312-win_amd64.whl

Download URL atomscale-0.21.12-cp312-cp312-win_amd64.whl
Size 4.7 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
ea636b842a9ca576c18a65f0f61324cdf144a66f0119f1cb7dbf8679e8b00562
BLAKE2b-256 checksum
How to use checksums
cf964ac0e649a1d82d425260f8d066b6c7c533fdfc1b744cfa8a1b86b9484e9d
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.12-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL atomscale-0.21.12-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
9eb2f2402c0c86ab6f138c6e2d8d266091a53fe63a51e36846dcfa12033c323e
BLAKE2b-256 checksum
How to use checksums
935fa230f5273c5493458bc56b2e27982a1ddf3234a2209b470126b5bd319abf
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.12-cp312-cp312-macosx_11_0_arm64.whl

Download URL atomscale-0.21.12-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
ebb5c6ca58567ba49c543b17dd1ff60400ea0f6e0f6a3faf5cf88feb591ef570
BLAKE2b-256 checksum
How to use checksums
39260e999e49e64335217f1a44ff2d5d28242c0fb95700c0b2446629d3ae3b09
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.12-cp311-cp311-win_amd64.whl

Download URL atomscale-0.21.12-cp311-cp311-win_amd64.whl
Size 4.7 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
8e00dc4a7a8ffcb380b5791b478fa68aa29e5523054fa39da3c1b20780720f54
BLAKE2b-256 checksum
How to use checksums
8098134639463ca39da0773321b7fccb41defbef85d4f1999255ac22963f9a36
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.12-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL atomscale-0.21.12-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
a5e1315b6caa1e0fe640ca12027acf6b247e29b7d4374a6f8e5e0c216699ec04
BLAKE2b-256 checksum
How to use checksums
15f477e71efcde7ea3dba7cc5d20a5a0e0c49e08abe5a384f8010f6e396acd3a
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.12-cp311-cp311-macosx_11_0_arm64.whl

Download URL atomscale-0.21.12-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
c1eafa20c040f4f5520c8374cfb436129ab290f242e5978e028181a9ab686a28
BLAKE2b-256 checksum
How to use checksums
db74c519e90fdbe74b7b91099d25a1adff1f1b1d9db128607671474cfda6cb79
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.12

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.12 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