Installation guide on Windows for developers

Follow these instructions to install the CityEnergyAnalyst (CEA) on a Windows system (tested with Windows 10) for developers

Prerequisites

Installation

  1. Open GitHub Desktop from the start menu.

  2. Clone the CEA repository with the following URL: https://github.com/architecture-building-systems/CityEnergyAnalyst

  3. Clone the CEA GUI repository with the following URL: https://github.com/architecture-building-systems/CityEnergyAnalyst-GUI

  4. Install CEA backend:

    1. Open a Miniforge Prompt console (you find it in your start menu)

    2. Type cd Documents/GitHub/CityEnergyAnalyst and press ENTER.

    3. Type mamba env create -f environment.yml and press ENTER.

    4. Type mamba activate cea and press ENTER.

    5. Type pip install -e . and press ENTER (mind the dot ‘.’!).

  5. Build the CEA dashboard:

    1. Type cd .. and press ENTER, then type cd CityEnergyAnalyst-GUI and press ENTER.

    2. Type yarn and press ENTER.

    3. Type yarn electron:build and press ENTER.

    4. You will find the CEA dashboard in the folder /Users/your_name/Documents/GitHub/CityEnergyAnalyst-GUI/out/win-unpacked/

Interfaces

There are different ways in which you can interact with the code of CEA.

  1. The Miniforge Prompt console interface: This is the command line to all the commands of CEA from your computer terminal

  2. The dashboard: This a web-based interface to CEA, open source and developed by the CEA team.

  3. The pycharm interface: this interface provides access to all the source code of CEA.

The command line interface and dashboard interface are included during the installation of CEA. Other interfaces require a few additional steps to get them up and running.

Running the CEA dashboard

In order to launch the CEA dashboard, you will need to do the following each time:

  1. Open the Miniforge Prompt console (you find it in your start menu)

  2. Type mamba activate cea and press ENTER.

  3. Type cea dashboard and press ENTER.

  4. Wait for start socketio.run to appear (This might 3 min the first time)

  5. Run the CEA dashboard located in (/Users/your_name/Documents/GitHub/CityEnergyAnalyst-GUI/out/win-unpacked/CityEnergyAnalyst-GUI.exe).

Here you can find a series of blog posts to help you get started!

Running CEA on Pycharm

In order to access and work on the source code of CEA from pycharm do:

  1. Download and install Pycharm Community edition (64-bit) OR your own favorite editor.

  2. Open PyCharm from the start menu and open project CityEnergyAnalyst (stored where you downloaded CityEnergyAnalyst).

  3. Open File>Settings>Project:CityEnergyAnalyst>Project Interpreter>Project Interpreter.

  4. Click on the settings button (it looks like a wheel) next to the current interpreter path, and click Add.

  5. Click Conda Environment from the left hand list and select existing environment.

  6. Point to the location of your conda environment. It should look something like C:\Users\your_name\mamba\envs\cea\python.exe or C:\Users\your_name\AppData\Local\conda\conda\envs\cea\python.exe. Where ‘your_name’ represents your user name in windows.

  7. Click apply changes.

Attention

We ended Support of Grashopper on 20.03.20. The legacy code can be found in our github repository/legacy

Attention

We ended Support of ArcGIS on 15.04.19. The legacy code can be found in our github repository/legacy

Updating dependencies