Installation guide for Windows

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

  1. Download the latest version of CEA (2.14) here.
  2. Open the installer and follow the instructions

Note

For installing the development version of CEA, tick the box “development version” during the installation.

Note

For previous releases please check here.

Note

To install from the source check here

Interfaces

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

  1. The command line 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.
  4. The Rhino/Grasshopper interface: This a 3D modeling interface to CEA.
  5. The ArcGIS interface: This a GIS interface to CEA (Not supported anymore).

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.

Pycharm

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

  1. Make sure to have installed the development version of CEA (see step 2 of the installation guide).
  2. Download and install Github Desktop (64-bit).
  3. Download and install Pycharm Community edition (64-bit)
  4. Open PyCharm from the start menu and open project CityEnergyAnalyst (default location is C:\Users\<you>\Documents\CityEnergyAnalyst\CityEnergyAnalyst).
  5. Open File>Settings>Project:CityEnergyAnalyst>Project Interpreter>Project Interpreter.
  6. Click on the settings button (it looks like a wheel) next to the current interpreter path, and click Add.
  7. Click System Interpreter from the left hand list and select existing environment.
  8. Point to C:\Users\<you>\Documents\CityEnergyAnalyst\Dependencies\Python\python.exe
  9. Click apply changes.

Grasshopper

Attention

This is a highly experimental interface to Rhino/Grasshopper, and we do not include any tutorials nor support to the public. for the time being, just a few modules of CEA have been integrated. If you are interested in support or would like to furthermore activate this interface contact shi@arch.ethz.ch

In order to install the interface for Rhino/Grasshopper do:

  1. Download and install Rhino 5.0 (requires a licence).
  2. Download and install the Grasshopper for rhino 5.0.
  3. Follow the steps of the installation guide of the code base described above.
  4. In the CEA Console type cea install-grasshopper and press ENTER.

ArcGIS

Attention

We ended support of Arcigs by the 1st of May of 2019. This means that there are not anymore tutorials nor advice on how to use this interface. You could still use this interface at your own risk. We invite all CEA users to get acquainted with the CEA Dashboard. The CEA dashboard is our new 100% open source user interface. We will aim to create a first tutorial on how to use this interface by mid-april of 2019.

In order to install the interface for ArcGIS do:

  1. Download and install ArcGIS Desktop 10.5 or 10.6 (requires a licence).
    • An Esri account must be created to buy and download ArcGIS Desktop, located in Products: All Products.
    • ETH affiliates are advised to access ArcGIS via the ETH IT Shop.
  2. Download and install the ArcGIS Desktop Background Geoprocessing (64 Bit).
  3. Follow the steps of the installation guide of the code base described above.
  4. In the CEA Console type cea install-arcgis and press ENTER.