---
description: Process for installing the Electron App (GUI) for eVOLVER.
---

# Electron App (GUI) Installation

For all operating systems, navigate to the [releases](https://github.com/FYNCH-BIO/evolver-electron/releases) section of the Electron App GitHub page.

1. [Mac](#mac-installation)
2. [Windows](#windows-installation)
3. [Linux](#linux-installation)

For instructions on updating the GUI on the RPi, see [Updating the eVOLVER Server](../../guides/updating-the-evolver-server).

### Mac Installation

1\. Download the `evolver-electron-X.X.X.dmg` file, where X denotes the version number in the latest release. The latest release should be the first one you see at the top of the page.

![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2FuSyw6fndwfU5w7stnrUt%2FScreen%20Shot%202022-04-11%20at%203.16.43%20PM.png?alt=media\&token=03667f4f-0bab-4f1c-952b-13da591cc758)

2\. When the download finishes, open the file (it should be in your `Downloads` directory) and drag the eVOLVER app into your `Applications` directory.

![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2FV3pWWXKsqAWkFQIsFyQm%2FScreen%20Shot%202022-04-12%20at%2011.02.17%20AM.png?alt=media\&token=154574b3-0cf6-4fd8-aa0a-3f8ee1362b14)

{% hint style="danger" %}
FIRST TIME INSTALLATION - DO THE FOLLOWING NEXT STEPS!
{% endhint %}

3\. Open the eVOLVER app from the `Applications` directory.

4\. Using an editor of your choice (TextEdit, Nano, Vim, TextWrangler, etc.) open the file `config.json` located at `/Users/<your username>/Library/Application Support/eVOLVER/config.json`

{% hint style="info" %}
You may need to enable the ability to view hidden files if you are trying to find this file in a Finder window. With a Finder window open, press **Command + Shift + . (period)** to make hidden files appear. You can press the keys again afterwards to make them disappear.
{% endhint %}

{% hint style="info" %}
If you are attempting to modify this file via a terminal, be sure to escape the space character in `Application Support` with a `\`.  It should look like this: `/Users/<your username>/Library/Application\ Support/eVOLVER/config.json`
{% endhint %}

![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2FizdQrKlHL2merzJ9wsFG%2FScreen%20Shot%202022-04-12%20at%2011.16.22%20AM.png?alt=media\&token=33d6dbfa-c85c-4043-8f5b-0c223b540d97)

5\. Add a line in this file between the braces: `"dpu-env": "/Users/<your username>/Document/dpu/venv"`

{% hint style="danger" %}
If you add this line to the beginning of the block, be sure to add a comma at the end! If you add it to the end, put a comma on the line before it.
{% endhint %}

{% hint style="info" %}
If you installed the DPU in a different location, be sure to reflect that in this line. The electron app uses this to find the correct python binary/venv to run the DPU
{% endhint %}

![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2FAmrWKiird9AuxeCJAHRw%2FScreen%20Shot%202022-04-12%20at%2011.31.17%20AM.png?alt=media\&token=74172cae-f0a9-4471-a0c5-c1c6d13c3ec8)

6\. Save the file and you're done!

### Windows Installation

1\. Download the `evolver-electron-X.X.X.exe` file, where X denotes the version number in the latest release. The latest release should be the first one you see at the top of the page.

![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2FfgSXulabykHNRaMem1XS%2FScreen%20Shot%202022-04-12%20at%2011.55.13%20AM.png?alt=media\&token=5e447d4d-b7db-4016-983e-8c53b0196749)

{% hint style="warning" %}
Chrome may flag the download, just select "Keep". ![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2FFjIaMg25UoS3WEkKgNDA%2Fimage.png?alt=media\&token=8c033bf1-5968-4675-9d9d-fb71485feec9)
{% endhint %}

2\. Open the .exe file.

{% hint style="warning" %}
In Windows 10, Microsoft Defender prevents the app from starting immediately. Simply click "More info" and then "Run Anyway" to get around this. ![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2F3lKNTDZ8JMJxLRv3BjyQ%2Fimage.png?alt=media\&token=bc56a68a-9ede-478f-809b-9f3807f0f7e8)
{% endhint %}

{% hint style="danger" %}
FIRST TIME INSTALLATION - DO THE FOLLOWING NEXT STEPS!
{% endhint %}

3\. Using an editor of your choice open the file `config.json` located at `C:\Users\<Your-UserName>\AppData\Roaming\eVOLVER\`

{% hint style="info" %}
You may need to [enable ](https://support.microsoft.com/en-us/windows/view-hidden-files-and-folders-in-windows-97fbc472-c603-9d90-91d0-1166d1d9f4b5)the ability to view hidden files if you are trying to find this file in a File Explorer window.
{% endhint %}

![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2FJsUVPgM3Is3fVuyDiimr%2Fimage.png?alt=media\&token=726fcd2a-d0c2-4c98-a5e5-0e25d64d3d82)

4\. Add a line in this file between the braces: `"dpu-env": "C:\\Users\\<Your-UserName>\\Desktop\\dpu\\venv"`

Note the escaped `\` , be sure to put double `\\` throughout the path.

{% hint style="danger" %}
If you add this line to the beginning of the block, be sure to add a comma at the end! If you add it to the end, put a comma on the line before it.
{% endhint %}

{% hint style="info" %}
If you installed the DPU in a different location, be sure to reflect that in this line. The electron app uses this to find the correct python binary/venv to run the DPU.
{% endhint %}

![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2F6uDKYeFoBrAAKKSfpswU%2FScreen%20Shot%202022-07-22%20at%2012.50.12%20PM.png?alt=media\&token=c52bb5d1-f10e-48bb-ae47-37d1e91b1055)

5\. Save the file and you're done!

### Linux Installation

1\. Download the `evolver-electron-X.X.X.AppImage` or `evolver-electron-X.X.X.deb` file, where X.X.X denotes the version number in the latest release. The latest release should be the first one you see at the top of the page.

![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2FbokRbnV5AQOhlNPkkWjh%2Flinux_wiki_picture.jpg?alt=media\&token=df3b88f0-4f38-4b4d-b104-ea93a5c62cc5)

{% hint style="info" %}
Selection of either .deb or .AppImage is largely based on personal preference and computer environment, each presenting slight pros and cons. If you are unfamiliar with installing Linux packaged software, use this link to learn more about what is applicable to you. Briefly, .deb files are natively designed for Ubuntu and will compile the entire application, along with necessary dependecies, onto the local machine. An AppImage file contains everything necessary to run the program, requiring you to execute the file when you want to run program.&#x20;
{% endhint %}

2\. If downloading `evolver-electron-X.X.X.deb,` open your `Downloads` directory and right-click `evolver-electron-X.X.X.deb` to open the file with `Software Install` .&#x20;

3\. A new window should open, allowing you to install the eVOLVER GUI. Click `Install` and follow the onscreen instructions to install the eVOLVER GUI.

![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2FkHZ4VDKGr9MLmkFdiLg9%2Flinux_wiki_2.png?alt=media\&token=a9b35164-3743-4f6a-b7c9-bde900a019e6)

{% hint style="danger" %}
FIRST TIME INSTALLATION - DO THE FOLLOWING NEXT STEPS!
{% endhint %}

4\. Open the eVOLVER app by either clicking `Show Applications` from the home screen or through the command line. To open via command line, open Terminal and enter to access installed applications:

```shell
cd ~/usr/bin
```

Run the eVOLVER GUI by entering:

```shell
evolver
```

5\. Using an editor of your choice, open the file `~/.config/eVOLVER/config.json` .&#x20;

6\. Add a line in this file between the braces to denote the location of the installed DPU virtual environment:&#x20;

`"dpu-env": <path_to_dpu>`&#x20;

![](https://3394537773-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYy5AdmKzUTn7D8n357Md%2Fuploads%2FxdyHcx5qqrsNeIZChcBA%2FScreen%20Shot%202022-04-12%20at%2011.31.17%20AM.png?alt=media\&token=eb9b3e88-2314-4bf7-a095-e91c77f3a416)

{% hint style="danger" %}
If you add this line to the beginning of the block, be sure to add a comma at the end! If you add this line to the end, put a comma on the line before it.
{% endhint %}

7\. Save the file and you're done!
