# Installation

## 1. Get an EMode License

- [Create an EMode account](https://emodephotonix.com/register/), and verify your account via the confirmation email.
- Purchase a subscription license through the [EMode store](https://emodephotonix.com/get-emode/). This is required, even for a free EMode<sub>2D</sub> license.

## 2. Set Up the Python Interface

Follow the [Python Interface](interface.md#python-interface) instructions to install Python and the `emodeconnection` package.

## 3. Download and Install EMode

**System requirements:** **Windows** 10+, **Linux** Ubuntu 22.04+ (x86-64), **macOS** 13 Ventura+

There are two installation methods:

### emode-install

The `emode-install` command-line tool is included with the `emodeconnection`
Python package. It handles downloading, installing, and updating EMode.
After installing `emodeconnection` via pip, you can run the installer.
You will be prompted to accept the
[EMode EULA](https://emodephotonix.com/legal/eula.pdf) and log in
with your EMode account credentials. For additional options, see the
[EMode Install](interface.md#emode-install) instructions or run `emode-install --help`.

```bash
emode-install
```

On Linux, installing to `/usr/local/bin` needs administrator rights, so
`emode-install` asks for your password through `sudo` when it runs in a terminal.
Without a terminal or `sudo`, or if you decline, it installs EMode for your user
only, to `~/.local/bin/emode`, and tells you if that directory is not on your PATH.

### Manual install

1. Log in to your [EMode account](https://emodephotonix.com/my-account/).
2. Select your operating system and version from the dropdown menus.
3. Accept the EMode End User License Agreement.
4. Click `Download EMode` to download the file for your platform.

**Windows**

Unzip the downloaded `.zip` file and double-click the installer
(`.exe`). Follow the on-screen prompts to complete installation.
EMode will be added to your PATH automatically.

**macOS**

Download the installer for your Mac: **Apple silicon** (M-series
processors, `EMode-<version>-Mac.pkg`) or **Intel**
(`EMode-<version>-Mac-x86.pkg`). To check, open the Apple menu and
choose About This Mac: the Chip line reads Apple M… on Apple silicon,
and the Processor line names an Intel CPU on an Intel Mac. The Apple
silicon build runs natively and is faster.

Double-click the downloaded `.pkg` file and follow the installer
prompts. Administrator access may be required. EMode will be installed
to `/usr/local/bin/emode`.

**Linux**

Unzip the downloaded `.zip` file and run the `install.sh` script:

```bash
unzip EMode-VERSION-Linux.zip
sh install.sh
```

## 4. Run an EMode Example Script

- Run the [Basic: SOI](examples/SOI.html) example in Python to verify your installation.
- A login window will open when EMode is first initialized. To subsequently access this window, see [EMode Login](interface.md#pythonemodelogin).

If you have any issues, please contact our [support team](https://emodephotonix.com/contact/).

* [Release notes](installation/release-notes.html)

* [Troubleshooting](installation/troubleshooting.html)