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

# Installation

> Requirements, installer options, scripted installs, and the Atomscale CLI for Windows 7 and XP

This page describes what the Atomscale installers do and the options they offer. To set up a computer from start to finish, follow [Set Up Atomscale](https://docs.atomscale.ai/gateway/set-up.md).

Atomscale support provides both installers: the desktop app for Windows 10 and later, and the Atomscale CLI for [Windows 7 and XP](#windows-7-and-xp). Each is code-signed by **Atomic Data Sciences, Inc**.

## Requirements

| Requirement | Details |
| - | - |
| **Operating system** | Windows 10 or later, 64-bit (x64) or 32-bit. On Windows 7 or XP, use the Atomscale CLI instead; see [Windows 7 and XP](#windows-7-and-xp). |
| **Permissions** | A standard Windows user account. Installing and updating need no administrator rights. A few features ask an administrator to approve a Windows prompt once: [Integration admin access](https://docs.atomscale.ai/gateway/admin-access.md), [Connection Sharing](https://docs.atomscale.ai/gateway/connection-sharing.md) Hub mode, and, only when admin access is off, the RHEED camera's [firewall rule](https://docs.atomscale.ai/gateway/reference/network.md#windows-firewall-rules). |
| **Network** | Outbound HTTPS (port 443) to Atomscale, either directly or through a Connection Sharing Hub on the same network. See [Network Requirements](https://docs.atomscale.ai/gateway/reference/network.md). |
| **Disk** | Free space for the upload queue. Each integration always leaves at least 1 GB free. Plan for the data your instruments produce during the longest network outage you want to ride out; RHEED needs far more than tool logs. |
| **Account** | An Atomscale account in the organization that will own the gateway. Any member of the organization can set one up. |
| **Clock** | Windows time synchronization turned on. The gateway corrects for clock offsets, but large jumps make timelines harder to read. See [Timestamps and Clocks](https://docs.atomscale.ai/gateway/data.md#timestamps-and-clocks). |

## Desktop App Installer

| | Details |
| - | - |
| **File** | `Atomscale-Setup-<version>-x64.exe` for 64-bit Windows, or `Atomscale-Setup-<version>-ia32.exe` for 32-bit Windows. |
| **Who it installs for** | The Windows user who runs it. Installing needs no administrator rights, and neither do the automatic updates that follow. |
| **Location** | `%LOCALAPPDATA%\Programs\Atomscale` by default. |
| **Shortcuts** | **Atomscale** on the Desktop and in the Start Menu. |
| **Log** | `%APPDATA%\Atomscale\logs\installer.log`. See [Files and Logs](https://docs.atomscale.ai/gateway/reference/files-and-logs.md). |

Run the installer while signed in to Windows as the user who uses the workstation day to day. The app runs for that one user, and the gateway runs only while that user is signed in to Windows. See [Keep the Gateway Running](https://docs.atomscale.ai/gateway/keep-running.md).

### Installer Screens

| Screen | What to choose |
| - | - |
| **Choose Install Location** | Keep the default unless the user's profile folder isn't suitable. Any folder the user can write to works. |
| **Existing installation found** | Shown only when Atomscale is already installed. See [Reinstalling](#reinstalling). |
| **Finish** | Leave Run Atomscale checked to open the app and start [First-Run Setup](https://docs.atomscale.ai/gateway/first-run.md). |

> [!WARNING]
>
> Don't run Atomscale with Windows' **Run this program as an administrator** compatibility setting.
> It isn't needed, even for RHEED network capture, which gets its rights from [Integration admin
> access](https://docs.atomscale.ai/gateway/admin-access.md). With it on, updates install but the app may not restart afterward.

### Reinstalling

If Atomscale is already installed, the installer asks how to proceed:

| Option | What happens |
| - | - |
| Reinstall and keep my data | The default. Sign-in, settings, integrations, their configurations, and queued data are kept. The computer stays the same gateway. |
| Reinstall and erase all local data | Removes sign-in, settings, integrations, and queued data for this Windows user. The computer registers as a **new gateway**. |

Either option recreates the Desktop and Start Menu shortcuts. Choosing a different install location on the previous screen moves the app.

> [!WARNING]
>
> Erasing local data deletes collected data that has not been uploaded yet. Before erasing or
> replacing a workstation, check that each integration's **Upload Queue** is empty.

If [Integration admin access](https://docs.atomscale.ai/gateway/admin-access.md) is on, erasing also removes it, which asks for administrator approval. If that removal does not complete, the installer keeps your local data and asks you to run setup again and approve the cleanup.

### Scripted Installs

IT can install without the wizard:

| Command | Effect |
| - | - |
| `Atomscale-Setup-<version>-x64.exe /S` | Installs silently for the current user, keeping local data if Atomscale is already installed. |
| `… /S /D=C:\Path\To\Atomscale` | Installs silently into another folder. `/D=` must come last, without quotes. |
| `… /S /allusers` | Installs for every user of the computer. Needs an administrator, and every later update then asks for administrator approval. Prefer the per-user default. |

A scripted install doesn't sign in. The Windows user still opens Atomscale once and completes [First-Run Setup](https://docs.atomscale.ai/gateway/first-run.md).

### Uninstalling

Uninstall Atomscale from Windows **Settings > Apps**. The uninstaller also removes [Integration admin access](https://docs.atomscale.ai/gateway/admin-access.md#uninstalling-atomscale) if it is set up, which asks for administrator approval. Queued data that has not been uploaded is lost.

## Windows 7 and XP

The desktop app doesn't run on Windows 7 or XP. On those computers, install the **Atomscale CLI** instead. It is a gateway that runs as a Windows service with no window, so it starts with Windows and keeps collecting whether or not anyone is signed in. It appears on the web app's **Gateways** page like any other gateway.

| | Details |
| - | - |
| **Operating system** | Windows 7 SP1 (64-bit or 32-bit) or 32-bit Windows XP SP3. The same installer also works on Windows 10 and later. Windows 8 and 8.1, Vista, and 64-bit XP aren't supported. |
| **Integrations** | [kSA 400](https://docs.atomscale.ai/gateway/rheed/ksa-400.md), [Tool Log Streamer](https://docs.atomscale.ai/gateway/tool-state.md), and [File Watcher](https://docs.atomscale.ai/gateway/file-watcher.md). RHEED Camera (GenTL) and FilmSense FS-1 need Windows 10 or later. |
| **Permissions** | An administrator to run the installer. The CLI installs for the whole computer. |
| **Location** | `%ProgramFiles%\Atomscale\gateway`. |
| **Account** | An Atomscale API key from the organization that will own the gateway. See [Obtaining an API Key](https://docs.atomscale.ai/api-reference/authentication.md#obtaining-an-api-key). |

**1. Get the installer**

Contact Atomscale support for the Atomscale CLI installer. One installer covers every supported
Windows version and picks the build that fits the computer. A Windows 7 or XP computer without
recent updates may not show the publisher.

**2. Run it as an administrator**

Approve the Windows prompt. On XP, run it while signed in as an administrator.

**3. Connect and sign in**

Setup shows one of these screens, depending on how the computer reaches Atomscale:

| Screen | What to choose |
| - | - |
| **Connect through another computer** | Shown when this computer can't reach Atomscale but finds a Connection Sharing Hub. Keep Connect through that computer checked, or enter the Hub's address. |
| **Share this connection** | Shown when this computer reaches Atomscale directly. Check it only if other lab computers will upload through this one. See [Connection Sharing](https://docs.atomscale.ai/gateway/connection-sharing.md). |

Then paste your API key at **Sign in**. If the computer has no connection yet, check
Sign in later with "atomscale auth login", and once it connects, run
`atomscale auth login` in a Command Prompt.

**4. Add integrations**

In the web app, open Gateways and find the CLI host: search for its computer name, and
check that its **App version** starts with \[CLI]. Open it, then add and configure its
integrations there. See [Remote Management](https://docs.atomscale.ai/gateway/remote-management.md).

To install without the wizard, run the installer with `/S` as an administrator. A silent install keeps the computer's current connection and doesn't sign in, so run `atomscale auth login` in a Command Prompt afterward.

The gateway updates itself; running a newer installer also upgrades it. To uninstall, remove **Atomscale CLI** from **Add or Remove Programs**. Queued data and settings stay on the computer for a later installation.

## Replacing a Workstation

A new computer, or a [reinstall that erases local data](#reinstalling), registers as a new gateway. The old entry shows as Offline on the web app's **Gateways** page; remove it there (see [Remote Management](https://docs.atomscale.ai/gateway/remote-management.md#removing-gateways)). Integrations, their configurations, and their **Growth Instrument** links do not carry over, so set them up again on the new gateway.

> [!TIP]
>
> Before replacing a computer, click Copy configuration on each integration's **Configure** page
> and save the text as a `.json` file. On the new gateway, use Import configuration to load it.
> Tool log parsing schemas are not included; keep your schema file as well.


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