Upload Data

Use the upload() method to send files to Atomscale. Analysis starts as soon as data arrives, and results appear in the catalogue once the pipeline finishes.

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",
]

Supported formats

Data Type	Extensions
RHEED video	`.mp4`, `.avi`, `.mov`, `.webm`, `.h5`, `.imm`
RHEED image	`.png`, `.jpg`, `.jpeg`, `.gif`, `.bmp`, `.img`, `.pdf`
XPS	`.vms`, `.spe`, `.spc`, `.dat`, `.txt`
SEM	`.tif`, `.tiff`, `.png`, `.jpg`, `.jpeg`, `.bmp`
Ellipsometry	`.txt`, `.csv`, `.dat`
Optical microscopy	`.png`, `.jpg`, `.jpeg`, `.tiff`, `.tif`, `.gif`, `.bmp`, `.img`, `.pdf`
Raman	`.txt`, `.csv`
Photoluminescence	`.txt`, `.csv`
SIMS	`.xlsx`, `.xls`
OES	`.txt`, `.csv`
Metrology and logs	`.csv`, `.txt`, `.log`, `.dat`, `.xml`
Archives	`.zip`, `.tar`, `.gz`, `.lzma`, `.7z`, `.rar`

Start the upload

from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
data_ids = client.upload(files=files)
print(data_ids)

Each file streams to the API in chunks. The method displays a progress bar for each file and returns the data IDs assigned to the uploads, which you can pass straight to client.get() once analysis finishes.

Link uploads to a sample

Pass physical_sample to group the files under a sample. Names are matched case-insensitively, and a new sample is created when nothing matches:

data_ids = client.upload(
    files=files,
    physical_sample="GaN-2025-001",
)

Link uploads to a project

Pass project to associate the uploads with an existing project. The project must already exist, since the SDK does not create projects, and physical_sample is required so the sample can be added to the project’s tracking list:

data_ids = client.upload(
    files=files,
    physical_sample="GaN-2025-001",
    project="Nitride Buffer Study",
)

Both parameters accept a name or a UUID.

Upload from file objects

You can also pass open file handles instead of paths:

with open("/data/rheed.mp4", "rb") as f:
    client.upload(files=[f])

Mute progress bars

For non-interactive environments, pass mute_bars=True when constructing the client:

client = Client(api_key="YOUR_API_KEY", mute_bars=True)
client.upload(files=files)

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.

Next steps

Search Data

Find your uploaded items in the catalogue.

Inspect Results

Work with analysis outputs and plots.

Samples & Projects

Group data across runs and align timeseries.

RHEED Features & Masks

Query low-level features and segmentation masks.

Introduction

Guides

References

Choose files

Supported formats

Start the upload

Link uploads to a sample

Link uploads to a project

Upload from file objects

Mute progress bars

Check status in the web app

Next steps

Search Data

Inspect Results

Samples & Projects

RHEED Features & Masks

​Choose files

​Supported formats

​Start the upload

​Link uploads to a sample

​Link uploads to a project

​Upload from file objects

​Mute progress bars

​Check status in the web app

​Next steps

Search Data

Inspect Results

Samples & Projects

RHEED Features & Masks

Choose files

Supported formats

Start the upload

Link uploads to a sample

Link uploads to a project

Upload from file objects

Mute progress bars

Check status in the web app

Next steps