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

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.7
File Size Uploaded Provenance
atomscale-0.21.7.tar.gz 1.0 MB Without provenance Details

Built distributions (wheels)

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

Total release size: 62.8 MB

Release files / atomscale-0.21.7.tar.gz

Download URL atomscale-0.21.7.tar.gz
Size 1.0 MB
Tags Source
SHA-256 checksum
How to use checksums
d5a242e491e7cfb2151d6dd88116d300c5ebe1d281eac07666d047c13495e275
BLAKE2b-256 checksum
How to use checksums
64aad14c9708c885f487bdf3cde96ca70ce5eedfe3c8c85272df3927eea53820
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.7-cp313-cp313-win_amd64.whl

Download URL atomscale-0.21.7-cp313-cp313-win_amd64.whl
Size 4.7 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
1151920aef35e95bc9234cce40fb0c0637771088cd0a3d3b1ddbdc0d5574f19d
BLAKE2b-256 checksum
How to use checksums
80600c7e2a03217aacf6098aef71d32df21d4d34bb4d8afd4a0cd408dfaac183
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.7-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL atomscale-0.21.7-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
a0f25571da31d9af605b92afbdf2a929397e3d5cb39f95181296fbef433bda89
BLAKE2b-256 checksum
How to use checksums
0a455775a78e633e10d4509be317ed138d32df0c3c4c47d73d2e92194792d7db
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.7-cp313-cp313-macosx_11_0_arm64.whl

Download URL atomscale-0.21.7-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
33c32eb2066eaee5be4f92f32ecc1a6c7b4d2c8b6eafbf28e3da3760d80cce0e
BLAKE2b-256 checksum
How to use checksums
009077fe520eca3bf86a4aaea870e58d7ad2f0cec6c6d6505d5ac0b428a763c1
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.7-cp312-cp312-win_amd64.whl

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

Download URL atomscale-0.21.7-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
e129fca5d44e808f815029bc243c903a7702088b2412a8cd1cb84005ec03918c
BLAKE2b-256 checksum
How to use checksums
39cebc4121fa4916ba49dc179ba9459b4eca21371968a44984033a69830e2744
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.7-cp312-cp312-macosx_11_0_arm64.whl

Download URL atomscale-0.21.7-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
95410509faca096daeba164537bc6e2ad3ccbcac13bdb2630f18542b7ca3b13e
BLAKE2b-256 checksum
How to use checksums
f08024a905ee54115f425814975c493f5683c04851f46e2fc5e15cadab43e9aa
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.7-cp311-cp311-win_amd64.whl

Download URL atomscale-0.21.7-cp311-cp311-win_amd64.whl
Size 4.7 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
fde68a214079f791b61c095039038b90f08110490fdf59ff0e398c749855280f
BLAKE2b-256 checksum
How to use checksums
467182d6011f4a879ed3c972d8051b87ffa98acf81b2a9352d816bb261647ce9
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.7-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL atomscale-0.21.7-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
51a488e8d65eacdae5ffad01c1136056a5c98dc6937f3bbfcd634a28ec13109b
BLAKE2b-256 checksum
How to use checksums
a0cadb18ca53b604e80986e9849c95f03a9cfedd387ed0ec708cd86661313109
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.7-cp311-cp311-macosx_11_0_arm64.whl

Download URL atomscale-0.21.7-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
0015ec3c49d1a560d24ca343cfdb1f62b895d5ffab99a471f8cb318cb81eee2b
BLAKE2b-256 checksum
How to use checksums
e08fa355c4c0d057cc41257cfc57ed5a3cfe26dac0af4823a6e31e4d80eb3136
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.7-cp310-cp310-win_amd64.whl

Download URL atomscale-0.21.7-cp310-cp310-win_amd64.whl
Size 4.7 MB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
5e1abc708c6280432c83fecf35e1c123db0d092c53cb51f233dc3647dfbb448a
BLAKE2b-256 checksum
How to use checksums
596c04fd2f004cce557bb059e7fae292e88d579bab86feceb2e27da15c6d3a8d
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.7-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL atomscale-0.21.7-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 5.7 MB
Tags CPython 3.10 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
6025c37d0304c89960aa290bd56547840f7cc2ea1cf4ae629765302a54c1367c
BLAKE2b-256 checksum
How to use checksums
e446b5cb706f2ec839a9c7564cd790faacab84b8cb901505331c752ec3eb62f4
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.7-cp310-cp310-macosx_11_0_arm64.whl

Download URL atomscale-0.21.7-cp310-cp310-macosx_11_0_arm64.whl
Size 5.0 MB
Tags CPython 3.10 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
a35a6ce32b195ba761917498f544307756b99ea87e08c634ecc8d6366fae14fe
BLAKE2b-256 checksum
How to use checksums
130739d3161cda70eb2a4a48b56ff9b25525cc14a288e1326573bc37c3b045b5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Security for atomscale 0.21.7

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.

Release history Release notifications | RSS feed

This release

0.21.7 This release

13 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