> ## 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.

# Tool Logs

> Stream tool logs, such as MBE cell temperatures, shutter states, and pressures, to Atomscale

Tool control software records the state of the system to log files throughout a run. On an MBE system this includes effusion cell temperatures, shutter positions, substrate temperature, and chamber pressures. The **Tool Log Streamer** integration watches the folder where these logs are written and streams each one to Atomscale as it grows, so tool state is available live during the growth and next to RHEED afterward.

```text theme={null}
Tool software    Gateway            Atomscale
┌────────────┐   ┌────────────┐   ┌────────────┐
│ writes     │──►│ Tool Log   │──►│ parses rows│
│ rows to    │   │ Streamer   │   │ into named │
│ run.csv    │   │ reads new  │   │ channels   │
│            │   │ bytes      │   │ (live)     │
└────────────┘   └────────────┘   └────────────┘
```

* The integration reads log files **read-only** and never modifies or moves them.
* It uploads each file's raw bytes as they are written. Atomscale keeps the original file and parses it into timeseries.
* For CSV logs, you name channels in a [parsing schema](https://docs.atomscale.ai/gateway/tool-state/parsing-schema.md). Atomscale recognizes common channels, such as source shutters and substrate temperature, and shows them under a standard name, for example **Source Shutter(element=Ga)** for `ga_shutter`.

## Supported Formats

| Format | Tool software | Parsing schema |
| - | - | - |
| **CSV** | Any software that writes delimited text logs (comma, semicolon, tab, and so on). | Required. You describe the columns. |
| **EpiTrend** | Veeco MOLLY's EpiTrend recorder. | Not needed. Channels, names, and units come from the files. |

> [!NOTE]
>
> The **Format** list also shows **Riber (CHR)**, but Atomscale can't decode native Riber CHR files
> yet. They upload but end with a parsing error. On Riber systems, export the recorder data as CSV
> and use the **CSV** format.

## Requirements for CSV Logs

| Requirement | Details |
| - | - |
| **A header row** | Unique, non-blank column names, and a single-character delimiter. UTF-8 or Latin-1 encoding. |
| **One new file per run** | Each growth or export writes a new file. Capture of a file ends after a period without growth, and later additions to it are ignored. |
| **Append-only** | The software adds rows to the end and doesn't rewrite earlier rows. |
| **A timestamp on every row** | A date and time, or Unix time in seconds. Timestamps without a UTC offset are read in the gateway computer's time zone. See [Timestamps and Clocks](https://docs.atomscale.ai/gateway/data.md#timestamps-and-clocks). |
| **Numeric values** | Channel values must be numbers. Text, such as `OPEN` or `CLOSED`, is stored as missing. Recipe and step names can be read from text columns with `recipe_columns`. |
| **A reachable folder** | The gateway can read the folder, locally or on a network share. |

## What You Get in Atomscale

Each log file becomes one **Tool State** data item named after when its capture started, for example **Tool Logs - 5:14 PM, Jan 6, 2026**. With EpiTrend, each hour of recording becomes its own data item.

| Status | Meaning |
| - | - |
| Stream Active | The file is growing and new rows are parsed. The tool state chart updates live. |
| Stream Finalizing | The file stopped growing and the last rows are processed. |
| Success | The whole file was parsed. |
| Stream Error | Parsing failed, for example because the file doesn't match the parsing schema. The raw file is still stored. See [Troubleshooting](https://docs.atomscale.ai/gateway/tool-state/setup.md#troubleshooting). |

A tool log joins the growth it ran alongside only when its integration is linked to the same **Growth Instrument** as the RHEED camera. See [Finding Your Data](https://docs.atomscale.ai/gateway/data.md).

## Set It Up

> [card] [Set Up Tool Logs](https://docs.atomscale.ai/gateway/tool-state/setup.md)
>
> Configure the Tool Log Streamer for CSV or EpiTrend logs.

> [card] [Parsing Schema Reference](https://docs.atomscale.ai/gateway/tool-state/parsing-schema.md)
>
> Describe your CSV log's columns, units, and timestamps.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.