Skip to main content
POST
/
rheed
/
stream
from atomscale.streaming import RHEEDStreamer

streamer = RHEEDStreamer(api_key="YOUR_API_KEY")
data_id = streamer.initialize(
    fps=30.0,
    rotations_per_min=0.0,
    chunk_size=60,
    stream_name="MBE Run 2024-01-15 AM",
    physical_sample="GaN-001",
    project_id="d290f1ee-6c54-4b01-90e6-d701748f0851",
)

"d290f1ee-6c54-4b01-90e6-d701748f0851"

Documentation Index

Fetch the complete documentation index at: https://docs.atomscale.ai/llms.txt

Use this file to discover all available pages before exploring further.

Starts a new RHEED streaming session by creating a streaming data item for live analysis during growth.
​
data_item_name
string
required
Name for the streaming session
​
fps_capture_rate
number
required
Frame capture rate in frames per second (must be greater than 0, max 120)
​
project_id
string
Project to associate the stream with
​
physical_sample_id
string
Physical sample being monitored
​
create_physical_sample_name
string
If set, creates a new physical sample with this name and associates it with the stream
​
rotational_period
number
Rotational period in seconds (for rotating samples)
​
rotations_per_min
integer
Rotations per minute (for rotating samples)

​
Response

Returns the UUID of the newly created streaming data entry. 
from atomscale.streaming import RHEEDStreamer

streamer = RHEEDStreamer(api_key="YOUR_API_KEY")
data_id = streamer.initialize(
    fps=30.0,
    rotations_per_min=0.0,
    chunk_size=60,
    stream_name="MBE Run 2024-01-15 AM",
    physical_sample="GaN-001",
    project_id="d290f1ee-6c54-4b01-90e6-d701748f0851",
)

"d290f1ee-6c54-4b01-90e6-d701748f0851"