Installation guide for Windows¶
Follow these instructions to install the CityEnergyAnalyst (CEA) on a Windows system (tested with Windows 10).
We advise to follow the above guide precisely:
- Be sure to USE
conda env createNOT
conda createfamiliar to experienced conda users. This command not only creates an environment, but also reads the
environment.ymlfile, containing a list of packages (and versions) to install, as well as a definition of the channels to check.
- If you need to create a conda environment for the CEA that has a specific name (the default is
cea) then use the
conda env create --name your-env-name-here
Installation of the code base¶
Excluding the above software, CEA installation requires approximately 13 GB of storage (depending on your existing Python library) and 1 hour of your time.
- Open GitHub Desktop from the start menu.
- Press Ctrl+Shift+O (clone repository) and select the URL tab.
- Paste the CEA GitHub address: https://github.com/architecture-building-systems/CityEnergyAnalyst
- Click Clone, this will take ~ 5 -10 minutes (Size 900MB).
- Open Anaconda prompt (terminal console) from the start menu.
cd Documents\GitHub\CityEnergyAnalystand press ENTER.
conda env createand press ENTER.
- Grab a cup of tea and some toast, this will take ~ 45 minutes.
activate ceaand press ENTER.
pip install -e .[dev]and press ENTER (mind the dot ‘.’ included in this command!).
Installation of Interfaces¶
There are different ways in which you can interact with the code of CEA.
- The command line interface: This is the command line to all the commands of CEA from your computer terminal
- The dashboard: This a web-based interface to CEA, open source and developed by the CEA team.
- The pycharm interface: this interface provides access to all the source code of CEA.
- The ArcGIS interface: This a GIS interface to CEA.
- The Rhino/Grasshopper interface: This a 3D modeling interface to CEA.
While the command line interface, and dashboard interface are included during the installation of CEA, the rest of the interfaces require a few steps to get them up and running.
In order to access and work on the source code of CEA from pycharm do:
- Download and install Pycharm Community edition (64-bit) OR your own favorite editor.
- Open PyCharm from the start menu and open project CityEnergyAnalyst (stored where you downloaded CityEnergyAnalyst).
File>Settings>Project:CityEnergyAnalyst>Project Interpreter>Project Interpreter.
- Click on the settings button (it looks like a wheel) next to the current interpreter path, and click Add.
Conda Environmentfrom the left hand list and select existing environment.
- Point to the location of your conda environment. It should look something like
C:\Users\your_name\AppData\Local\conda\conda\envs\cea\python.exe. Where ‘your_name’ represents your user name in windows.
- Click apply changes.
We will end support of the ArcGIS interface by the 1st of May of 2019. This means that there will not be 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:
- Download and install the ArcGIS Desktop Background Geoprocessing (64 Bit).
ArcGIS (with Background Geoprocessing) is required to run the thermal network layout script. Otherwise, ArcGIS is only used for visualisation purposes.
Follow the steps of the installation guide of the code base described above.
In your command line Type
cea install-arcgisand press ENTER.
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 email@example.com
In order to install the interface for Rhino/Grasshopper do: