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.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.19.0)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for chris.ADS from gravatar.com chris.ADS Avatar for jmunro from gravatar.com jmunro

Credits

Author: Atomscale

License

GPL-3.0-only

Requires

Python <3.14, >=3.10

Provides Extra

dev docs

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atomscale-0.16.0.tar.gz (855.4 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

atomscale-0.16.0-cp313-cp313-win_amd64.whl (4.4 MB view details)

Uploaded CPython 3.13Windows x86-64

atomscale-0.16.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.17+ x86-64

atomscale-0.16.0-cp313-cp313-macosx_11_0_arm64.whl (4.8 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

atomscale-0.16.0-cp312-cp312-win_amd64.whl (4.4 MB view details)

Uploaded CPython 3.12Windows x86-64

atomscale-0.16.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64

atomscale-0.16.0-cp312-cp312-macosx_11_0_arm64.whl (4.8 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

atomscale-0.16.0-cp311-cp311-win_amd64.whl (4.4 MB view details)

Uploaded CPython 3.11Windows x86-64

atomscale-0.16.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64

atomscale-0.16.0-cp311-cp311-macosx_11_0_arm64.whl (4.8 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

atomscale-0.16.0-cp310-cp310-win_amd64.whl (4.4 MB view details)

Uploaded CPython 3.10Windows x86-64

atomscale-0.16.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.17+ x86-64

atomscale-0.16.0-cp310-cp310-macosx_11_0_arm64.whl (4.8 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

File details

Details for the file atomscale-0.16.0.tar.gz.

File metadata

  • Download URL: atomscale-0.16.0.tar.gz
  • Upload date:
  • Size: 855.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for atomscale-0.16.0.tar.gz
Algorithm Hash digest
SHA256 dca1585d7461d90d0851cbbe54f0d7d8264478401617bdf38c14ba0b5a9faac0
MD5 49e17ed6bd9de85d9606dc7bea6d0af9
BLAKE2b-256 bfa5b7e2db424685bb5c6687d22a105374c223a976c98c1c1ea5f08090fa1ac7

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp313-cp313-win_amd64.whl.

File metadata

  • Download URL: atomscale-0.16.0-cp313-cp313-win_amd64.whl
  • Upload date:
  • Size: 4.4 MB
  • Tags: CPython 3.13, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for atomscale-0.16.0-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 ab3842b55dc2eafc66dc5cf96fef016b2757c166a0c67a13d93d779a7c161285
MD5 c6cd89a1c69c7c47e156a3ad84187581
BLAKE2b-256 8f2bcda708b845c8928f4cf0e4520df90a6b8a0565ab74dac6849cd12f569af8

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for atomscale-0.16.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9372a2d1b0ef3add1d1eb438367e9510884e00d4b872f78917dd70ef09f2c0ca
MD5 a062f5aabdc8bfbee89226cab294bc3a
BLAKE2b-256 35fcc168097a1fccc7f300c55649ff0cff2b39052447031b15b6aec6bd15286f

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for atomscale-0.16.0-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1d0d0d8d7c39077835fa9456a285d80cf3f7d6a92418e8c2091d0de24cbe7d34
MD5 69ac04342b56cd82afabf7e7a435096a
BLAKE2b-256 fa9004f8b70dd574320b53b3a5cb9d388a318fc9f73359382ffd68fcfbff562d

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: atomscale-0.16.0-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 4.4 MB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for atomscale-0.16.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 a1dd398d07545fbdd50f8103084613ceaf1967ae8917a326780c719395397753
MD5 a12a759d464096fe62781f45be4b5a93
BLAKE2b-256 6c613496f46c3d879b70022e9aad79e9b0193dd89529dd8c07c46bf9c5cc6faf

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for atomscale-0.16.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 0ef70131fed00b875c17db09272029b6904b5ef24219722f689bfb817e3e46a3
MD5 28b812ee54800c90d9d6d1efd84a3477
BLAKE2b-256 39ff23da0a814c01211c5aebb1ccd50e53d51ddd3056ba5ea98e0f573d376cd4

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for atomscale-0.16.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 535cd0b27714fd25d7a251ad2c3de8be7788274687059a479b3e6aa61a8e92da
MD5 f52cd51cccab940f74c9f515cfa0f829
BLAKE2b-256 29f51314117bbcac50b71451a1ac3db971ce5c28597e869686cb0bff22a6b139

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp311-cp311-win_amd64.whl.

File metadata

  • Download URL: atomscale-0.16.0-cp311-cp311-win_amd64.whl
  • Upload date:
  • Size: 4.4 MB
  • Tags: CPython 3.11, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for atomscale-0.16.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 febf35828fd2b330713359cfc25c2f556d7808b8bd5f955ceb2c2ca9eca759dd
MD5 20efeb139476ff0166bcec8905431962
BLAKE2b-256 0a8202f8cc21b0746f8ae113704200d1ccdd46b6701a53037702632ae145f52c

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for atomscale-0.16.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 12ea43d8ed5d7c27816c6be6026d5853ce872a9f7c75a3124fd2d9829c4f7e47
MD5 2964dcf0e0833893a86e55251b285037
BLAKE2b-256 80b745094e9dde0893eb82e4beae08cf738be9adcf480c214fed7f7ca5bab478

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for atomscale-0.16.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 5fa02bf67ce1f9be81af8be2eb6d6fe06ef1cae47a969769db8ece1acc7fb9a3
MD5 50f134b8ebba7947fb2aff9420210d28
BLAKE2b-256 ea9580e360526e64fe63945a732d393ab3937ca716798db35e168994f58d9dc6

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp310-cp310-win_amd64.whl.

File metadata

  • Download URL: atomscale-0.16.0-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 4.4 MB
  • Tags: CPython 3.10, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for atomscale-0.16.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 03b373712729c5d5fa2b81829f45dd7d047283a7427e21d7875b7be15c0d3825
MD5 366a90ab1ffbd2535e17a8f51c833c63
BLAKE2b-256 43067696b713366fcca5e265407307ae509febe661b8a914606ef1b9eb5263b2

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for atomscale-0.16.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f21623d1c009ff03ab97b8d9df7e84e882a318db5856d901c77a65517f57c4c7
MD5 f73c57b14bdb2f4b9382283ebf781f17
BLAKE2b-256 4f87702a2406849de79e407cd737005407f61f73a4282cdff7e2220fad953782

See more details on using hashes here.

File details

Details for the file atomscale-0.16.0-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for atomscale-0.16.0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c190515134d4dedc47d094abaa27fd7c598d2ed7e182e5c7f561132d582ea318
MD5 e2ec4048dc0dfe2097abbc67281afe0c
BLAKE2b-256 4b3c7ec2124edf3dd32f71ffd7dd308bcc12c08615ac76b9264a586f4f952c30

See more details on using hashes here.

Release history Release notifications | RSS feed

0.19.0

13 files

0.18.0

13 files

0.17.0

13 files

This release

0.16.0 This release

13 files

0.15.5

13 files

0.15.1

13 files

0.15.0

13 files

0.14.2

10 files

0.14.1

10 files

0.14.0

10 files

0.13.0

10 files

0.12.0

10 files

0.11.0

10 files

0.10.2

10 files

0.10.1

10 files

0.10.0

10 files

0.9.0

10 files

0.8.3

10 files

0.8.2

10 files

0.8.1

10 files

0.8.0

10 files

0.7.2

10 files

0.7.1

10 files

0.7.0

10 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page