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.17.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.17.0-cp313-cp313-win_amd64.whl (4.4 MB view details)

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.11Windows x86-64

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

Uploaded CPython 3.11macOS 11.0+ ARM64

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

Uploaded CPython 3.10Windows x86-64

atomscale-0.17.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.17.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.17.0.tar.gz.

File metadata

  • Download URL: atomscale-0.17.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.17.0.tar.gz
Algorithm Hash digest
SHA256 e73b9b55cf2ed8120c221da973fb315c88bb8bdb8a0e02429a8d69b69f80f5f8
MD5 6154f5818dcc93f3d6c1901fc26c290b
BLAKE2b-256 dba4aa44c15c5b094222d4db2b5dfb4fca744f8ed40a6377c99525c727f3c8f4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.17.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.17.0-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 46470bd9aaa2dfa60a724d2b97866d409852f65d9b8c6ff34457c33ed78cc73f
MD5 867c9284ec3ae4b9ef55450cbc660fe3
BLAKE2b-256 6e707c3d268893079d6b7a3eebfec8216b44b89860a7597c5d139cf7a626a32a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.17.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 372a2626bc7d8189d455f85a1d02f653b53a1d2a87e8bc11b620c31f535715df
MD5 72ef61a57ffd06bbbe7608bec6b167ae
BLAKE2b-256 fb2c323c6dbdcc60486985cca332a8096e1a9f5c10c43bfdc8edf1fda41b4859

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.17.0-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 232acdf6b46c9f7261531e75adc5fe6d976799e9c2a4d8dcb99744492769a704
MD5 35375713472491daebbe5b5d2267b239
BLAKE2b-256 f7796fcbb18ec9219f622f86447fb21976943d0f14b7240ca4de779f99aef39c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.17.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.17.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 0615b78a608c477482a0f29c1c14f055eacd9ec12324a76164d1fa41e19a9981
MD5 46bcfe138803f38835cea647408627f2
BLAKE2b-256 848e4807b862d1793bac1d9fd9cfc5e37e5ab8fe3a01268ebedc83e1e6467b2b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.17.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ce3efcae64f002657be53c50c840d7428686dab6ab45ebfe51b0ee4f713a2ec0
MD5 c86b125037932f92b8b17dcf92a425dd
BLAKE2b-256 4961c931e8aa090bb822a7f9c23f7356841f8d15987f7ef9bbbd14e194b61a94

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.17.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1914f7bf1c671a2257bb99a1dc872197a92c21690b467d25d1ce1cbdae693f6a
MD5 f5350c858b1425d0b280240840f25b28
BLAKE2b-256 1bc70ea24222783cdc91152f482f6a19dc4db7e412de78a578982526f8cb5103

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.17.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.17.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 21f430f9569c589ee762811f4b4e2cdaa70d89690ac75b71f2193debe43d9291
MD5 6a785b77a1872bd48c43f300cea44450
BLAKE2b-256 a26a10b8d75f3d7b645e01b9f0499d54cb07f8e5dbf2316b870bde618de89dbf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.17.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 e47c4757ee1b1cf3ed9455403ccec35cb1bf5292cfe061d43df1da9b31b8df02
MD5 f5434230b63a36d371189fb586b4a513
BLAKE2b-256 66387061f9abd3c5abeeddc0c16976184be3bbb4897212631618fc6e9a4f8263

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.17.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3d65b0ac0a2fbb0fcf8099fd3285fb237af7923dd72e3802f844e78b5dba22e9
MD5 8b9088162e467effa71e01b627ef8532
BLAKE2b-256 a975bf7df3c5d25e4259cbb93d3703349f00ef753ed9ae74191ecead4348c34f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomscale-0.17.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.17.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 b4cc9a8c43458849ea68c834fdbdb533475cddfd600849d750d3a809171a3074
MD5 26e75c39c766a99eccb6a9d9bc635583
BLAKE2b-256 36ac41f15653f5675729ea368ae99e4e2f4c8a10e77c574c7da4486126ae2286

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.17.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 be453165969707706bfbaae540502eb95ffe005021df2fcf4f900a1d72f2ed98
MD5 36b2c317575ac498d7cfca6ab98c13f0
BLAKE2b-256 8b2ba999c485decca0fbd8bc266613d71528b1a1b6796341d6ad0d08e4470be2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomscale-0.17.0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b118c4f7ee04d8eec4e244eeba8c0de2f18a704ee75cf53ed83c0cc93e2e6398
MD5 883f7bf85ea7836fe3decc41de6179d8
BLAKE2b-256 f7ebd9918f0f7e397688a56d9ee7ecbd178f13b21f1c2c3b0b79a15944f544d2

See more details on using hashes here.

Release history Release notifications | RSS feed

0.19.0

13 files

0.18.0

13 files

This release

0.17.0 This release

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