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

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

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

Uploaded CPython 3.11macOS 11.0+ ARM64

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

Uploaded CPython 3.10Windows x86-64

atomscale-0.18.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.18.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.18.0.tar.gz.

File metadata

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

File hashes

Hashes for atomscale-0.18.0.tar.gz
Algorithm Hash digest
SHA256 54f4f250b93fab62d896c777e32686907fbef643d7eab1951622ebe4c8542d1f
MD5 c3e959c4488cd8d9d87e4d78de732210
BLAKE2b-256 1cda5c15129ce5b3a22705cefe32ce0fa608b264bc37c12b70bf359320337d1f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.18.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.18.0-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 1c819cf770b48fd9b63d301c3d2976f5fb9beb423d0e6976ae68fec7383645b8
MD5 4d79d8afde34970854e56f8c70d5887d
BLAKE2b-256 9d48a7e2de376faf82f42bafe65cf0768110e61d67e7466f1c89e9f2a4c073ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.18.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 531768a07a15bc9c78ba7860f70269a47e3fbdd13cf3403b664ec81c600dcdfc
MD5 7077524a501ff24397fce3a8dd3ddcc8
BLAKE2b-256 cc2364a445ec95ea63f7b3bb924c5166c2a0a122ace37b07f6662fa06460d73b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.18.0-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c92153e4a2534c936407375033439406488dfe629afb06ccaf3447afa2338efa
MD5 dd5e483b6813648f9c6846b5a57aba81
BLAKE2b-256 f50b8c89444b7016b5113c89d763d236025bfa9362ca6c5f07af81917fb1c30a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.18.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.18.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 71c680902d047c70ece8e2de00b93021edae10f68fa40f2a58e7b0ff73635bb8
MD5 74dc62dd59f8b44cb3f31d5feb056116
BLAKE2b-256 ebc1af99f5c11709bae463efeb02049aea012303cda9443d5f8500ef649f89db

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.18.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 487dab63842ded80620f8b561b87dde97a4eb71ad2a8f374c794e9c255bbef94
MD5 abf8f63a75385512de3e39ec8000761d
BLAKE2b-256 641355820c9bee6bc83bf7d4f95c2c26a6184f3810f43d35d80db07e94a8f358

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.18.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3ac70963cb053a9132db6b4724c8fdd6e0dc50676f1ef0dc67c85eaa2e2c761c
MD5 2234f206745b1b36b8f21e0f81a07d00
BLAKE2b-256 3d1b3bf61e95494f53073e0ebf186a7555035e4af1c335d1e607266cef71a707

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.18.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.18.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 de0cf7988c4c16da1d3a2758e281f3abec21721cae0443abe7a47fd59db3e5dd
MD5 1b7ceedabfed7f3539a24ae772e02ad7
BLAKE2b-256 3d68de9af5d89d7a3c63ac751533a1677bb5279809219a5822d481c7a72bb6d5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.18.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 7d17ba7034b731a0918d9017d90ac9e899d6297af04e28516c459e679af3d181
MD5 25f330cc32238876769fa41e93eeed7c
BLAKE2b-256 1f5c1ff635dbd807b4660b5c2c039480a889c0ef28c3af939684fbee19ff735d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.18.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 97cdbc379a0508a0fe63118113d15756c1f608271382c04cffd54228df23c8b3
MD5 07aae7536301e0843b7798fbe0b71495
BLAKE2b-256 749ca65aec40b6368b812ee4b68f936ed681ba66c34e6e57bf73184b1e6b4499

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.18.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.18.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 92df50e39dc87ab7561b58618fdfc06e1a82a126f09004cde2600908af41602e
MD5 319b9bac6d3758883f60848a92a3ef59
BLAKE2b-256 1a266acd1a364f80dfb45c24640fad3603b85976abf2adc72749bc665870fc4b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.18.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4599ef80abb55971b8e78ebc94bc9cb54f881e772a3edddd16bb5bfc9983fe09
MD5 b47bc09a545493dfcca2e8d4a4f841df
BLAKE2b-256 37113b9d5ce30a222ea0eec08915232617c4471d86e60ebd5a0bc97e80d0dca0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.18.0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 284fb50e9af06716b2ec652bfe975a6d93df3bed9a7abec133d1510e18f62f50
MD5 7b8c734d431f0cd8c43a58762f238d7e
BLAKE2b-256 064ffd79cf9b2bc9a07f7673c75150bf9b04d800c3507cf892ba52e65167cfbc

See more details on using hashes here.

Release history Release notifications | RSS feed

0.19.0

13 files

This release

0.18.0 This release

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