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:
Latest release

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

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

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

Uploaded CPython 3.11macOS 11.0+ ARM64

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

Uploaded CPython 3.10Windows x86-64

atomscale-0.19.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.19.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.19.0.tar.gz.

File metadata

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

File hashes

Hashes for atomscale-0.19.0.tar.gz
Algorithm Hash digest
SHA256 22c7fe9c7697fca8ae32321c3891d853469a1bf4721300d27fea245fa1f4cc28
MD5 596a93420cbe1e215928a2b758f34a8c
BLAKE2b-256 a11ed5a1979dacbdd8ed04255104a38f23276854cac69749b1407bf955937b64

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.19.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.19.0-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 2ce929a1b0793db8e85f3138c3552808d69b4bf9fd0821c95d49faf974f070c3
MD5 3bb596f6b38c22ab0c9a5f4de8ebef2c
BLAKE2b-256 a41e365e4b66acfe0c626f9777d6bbfb2ae9411350fcba6ecd08a2587be4751d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.19.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f62154fe8990b76bb380c4a4183cc63562932a40d842d451bd919af3dd8494ad
MD5 71e625086a43e30a845e40bbd31e58fb
BLAKE2b-256 e378baae9409b25f8cc5db4aef5a5071eb14777ce82617f18b6d8f57d65303d1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.19.0-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7576e989b242f4e63cbd3878d2cebd8a414cf5d009a389cb0bdf3342767f6e32
MD5 04d9457e7f42bb10fc08dc09bafd8d76
BLAKE2b-256 50ce0b7e856eb533f2d07db06d89a9dcbe2a5f2d0b4bf5faf4759fb29936e112

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.19.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.19.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 a433f88eedd114fc16039986bcd794bc0fb96d37028168df726986d8fa0ab487
MD5 2290e37e82c9a60e5d800d53b61f76d9
BLAKE2b-256 8d13925aa6f907b98ebc0f8ee0d8bf9273e31c65919d0c904102085b4147a4be

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.19.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 d7fb3b7b950ef838a2be95fa31deee8d81dd45a182dff4181789eea0de97f0b0
MD5 c48d34ae30c640d87b0ed10ebdcd6a1d
BLAKE2b-256 75ca1938fb926b6663d5834967ef197d885f5aeabc38902595024fd156d7139e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.19.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 94be2e58c51d836096c574c3dec4ceca9452221bd697d7053cc939b6274c85aa
MD5 08af6406071d37a1e212bd1da4570b71
BLAKE2b-256 20c8f950972a4482eb0ccb71eb08ecce54e1c2a1a14278daddeb812317288002

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.19.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.19.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 f9b86be3278f58215555300b6bce58b6e4f951e204912fbfca6a7ed9cd9e2746
MD5 b43e2fd97c3f67602a7ae8e89c8c3162
BLAKE2b-256 a6fc181706416f3ecc64d7bfee5afeea405ef6c96b7ba4f16de5c5ebe090417b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.19.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 025015a420807c4a30d611ed0fa9a9df4148d16b9ee80cdf09112281c2f99ac4
MD5 3d754936f6dc15887e2aab68726fd150
BLAKE2b-256 529ccb6c9ffe77431f0cd5f57f92ff3e6bf66ec7e97f9446a5c19a69f7d9fc9a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.19.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 44df84769a5331f2733fc1b03e69e75e528f909621162402ccd3d92eded80a2e
MD5 575125bf7b61f0ef139509004b1b5631
BLAKE2b-256 aa322c2989b1c620ce4259dfff23c558cde453daad286482bc85c28f4c36a48b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.19.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.19.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 27e39c63f1947b4848ed6840d8b88c75cacc2e4c74c40fb1d1336d66fc9ac6e2
MD5 0872465c5e0145a3bb2fb0fbc3b9287e
BLAKE2b-256 af59936bb0910d700be646458c0ec063235cec0519a77507aab5b431fc75add4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.19.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a10bb808699c64fe5fb93f355f111b2778c14c52ac2e3ca0b9b544c84c29457e
MD5 855542ec76cbc7640a4c98e88edca01f
BLAKE2b-256 16ff40fc5fcfdc5efa2f442f74a3ac41742db53727a3e1d5379c563198cd7bbd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.19.0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 06ee717259fbb7cfe036b375a665cfa32363bf436d2389dc3b97986f00b915aa
MD5 47fba0f50b7d904b2ea28ffc4393be31
BLAKE2b-256 5fa5ed56dc509cfdab027bd086e9df2dbc5eff2edb9dbb394fa03219ac373bee

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.19.0 This release

13 files

0.18.0

13 files

0.17.0

13 files

0.16.0

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