Upload Data#

This guide adapts the Uploading Data section of general_use.ipynb. Use it to send new RHEED videos, images, or XPS files to Atomscale.

Choose files#

Collect the local file paths you want to upload. Mixing file types is fine.

files = [
    "/data/growths/2025-02-10/RHEED-stationary.mp4",
    "/data/growths/2025-02-10/RHEED-rotating.imm",
]

Tip

Supported formats include .mp4, .imm, .png, .jpg, and XPS data files. Check the web app for the full list of accepted extensions.

Start the upload#

from atomscale.client import Client

client = Client(api_key="YOUR_API_KEY")
job = client.upload(files=files)

Each file streams to the API, and analysis starts as soon as data arrives. The upload() call returns a handle you can inspect for progress details.

Note

Large files are uploaded in chunks with automatic retry on transient failures. You don’t need to implement resumption logic yourself.

Mute progress bars#

If you are running uploads non-interactively (for example in CI), pass mute_bars=True when constructing the client:

client = Client(api_key="YOUR_API_KEY", mute_bars=True)

Check status in the web app#

Uploads immediately appear in the Atomscale UI. Analysis runs in the background, and results land in the catalogue once the pipeline finishes.

See also