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.15.5.tar.gz (846.0 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.15.5-cp313-cp313-win_amd64.whl (4.4 MB view details)

Uploaded CPython 3.13Windows x86-64

atomscale-0.15.5-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.15.5-cp313-cp313-macosx_11_0_arm64.whl (4.8 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.12Windows x86-64

atomscale-0.15.5-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.15.5-cp312-cp312-macosx_11_0_arm64.whl (4.8 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

atomscale-0.15.5-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.15.5-cp311-cp311-macosx_11_0_arm64.whl (4.8 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

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

Uploaded CPython 3.10Windows x86-64

atomscale-0.15.5-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.15.5-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.15.5.tar.gz.

File metadata

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

File hashes

Hashes for atomscale-0.15.5.tar.gz
Algorithm Hash digest
SHA256 8c8bc5b16195ea5b0829a39fc18b59124929ab39bd1de59c821867b161572ccb
MD5 824a6c082c1fdaba9ace973289301db4
BLAKE2b-256 05dade4db1191c01e0810846c4d930b9dd4e09100471688e5b0bb09b04253654

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.15.5-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/6.1.0 CPython/3.13.14

File hashes

Hashes for atomscale-0.15.5-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 12a5897e5954f2b09ffc09ed6e3eb3d34410eae34fa7ea671c644989ae969a4e
MD5 9095a00eac0e75cb6426806784aa3413
BLAKE2b-256 84c47e0645d5f93b8e3173fab4d2deee5e911f11c11180f86e9fffcb6c1d594f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.15.5-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f43e99faf276d6aba50122f66e7f0667728763e938f180c7c078800695089fea
MD5 fe89fdfd4c368589028cc3f2b3256aae
BLAKE2b-256 9bdb3a9c0d416ad558f7cd5011f11994be4ffc9646326381296abf25c24b6a77

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.15.5-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 fdc563c9204806493d6377b826f9aacd2c1357df3e84260232a705d01dfd3623
MD5 c2bdc1352a3c554cbd4f89c41638cc59
BLAKE2b-256 63c8ae536396d7e476b514b56a631b3a3293b4b0480982aa8f60c31c1825c88e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.15.5-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/6.1.0 CPython/3.13.14

File hashes

Hashes for atomscale-0.15.5-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 37abceddb6c490fa484c7947a88c710cd0f0d4e8c5ac779336606a144a598d8f
MD5 0c6c7e52542d967d1abfda78f7e53309
BLAKE2b-256 36d4e9a17e4be067d50f354014bcbaa96cd9f974cae657680410df11fb6f9388

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.15.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a255bfa65cf2ac80d0b0f0f3eb74f00cfcd0dbf02adacdb04f0c6ad4268ff6be
MD5 8f2673de7a48de5f6675b7648c599e05
BLAKE2b-256 01f695c8b6611f96cdfd784e9c83cd7225ca551f4d5c3205785f67cfa6bf7a0d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.15.5-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 66518d78866b12e52a45a73f523e45af108081c5dfeb047b5bccfbc5086363c3
MD5 c2520ec29221e2c8d2e939079a01941d
BLAKE2b-256 7b652bfc19380de2688c7acc0dcb799f444a9b04819d057dfdd63487d76b73eb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.15.5-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/6.1.0 CPython/3.13.14

File hashes

Hashes for atomscale-0.15.5-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 04e4fee0e15d6ed2a5ce76f681f6b3d5cd9c3b5780dde013ffbf73bf60415f82
MD5 74cd0940518c037d876cc0a18b268af8
BLAKE2b-256 a73e01b8824371e4c46d306855d51c14e29306140eac9028d11832b871e611f6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.15.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 8ecc850aff82a86a8755703ad8b752f4242465e7f533ce9eda7a194a734fa079
MD5 b5243c6fd6225e0b54ccbb22ab675f27
BLAKE2b-256 625cedb5a4264fcb0fe36dabb83c71ebbed15a5bf3dd464a0e6fffe35a987ca0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.15.5-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d61bf6d28605fea1eea49071e7252af4f3c67864675d366306ba86ef27e73b41
MD5 7d82799f5dc76b809b8683b6ecfd722f
BLAKE2b-256 c013d76efe3b69f52bc90b372df45ede3af03b12c56d1feb9586c2730f0cac62

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.15.5-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/6.1.0 CPython/3.13.14

File hashes

Hashes for atomscale-0.15.5-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 2a2df5271919704971ddb717c703bb4a539cbf7b13c73fc0f60f741e09d17a90
MD5 e1c2e00827ccd785ed8eebfc8b5310b9
BLAKE2b-256 e7949b0a7a34ceb0466ca24a17460f25c92067103427fb91c270aa3623e591d5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.15.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 559bb8e2312e02bf4d00d2b27e1b53c569d4dba89f17fa856ce4e7d72298b267
MD5 4727cfd9beead6c29f4436d9e385b6c9
BLAKE2b-256 c5f0b88f1b1cdeb9abaa2c24741b0d18d0c4962915866c9c2107fdfe89a26337

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.15.5-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e60db9f981bf807e99eeb637499de3eff11142e0f789242e0bb9bcc24f4674a6
MD5 66b7c8afa4eeb3f393b800bc37bf8b1f
BLAKE2b-256 843b16dc57e1c7c7c92c9abeb463a64c3e90d81ae70cf60358c6d5e8d1708004

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

0.16.0

13 files

This release

0.15.5 This release

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